Distribute the Keys - Checkout

The checkout process submits the Keys you have created to the Service Providing Person. Make a POST request to:

https://api.unloc.app/v1/partners/Your_Service_Provider_ID/key-requests/Your_Key_Request_ID/checkout

And include the following:

Invitee: The mobile phone number of the person providing the service (using the E.164 format)

Example:

curl --location --request POST '<<api_url>>/v1/partners/<<service_provider_id>>/key-requests/<<key_request_id>>' \
--header 'Authorization: Bearer <<service_provider_api_key>>/checkout'
--header 'Content-Type: application/json' \
--data-raw '{
    "invitee": "+47555444333"
}'

A successful response will return an empty JSON object.

If you try to attempt a Checkout on a Key Request that hasn’t been approved by the user, you’ll get an error response:

{
    "error": "badRequest",
    "errorDescription": "Key request 36b80f06-0af7-401f-86c9-baee6edf9eec is in a invalid state."
}

After a successful Key Request Checkout, the person providing the service gets the required keys on their device and their lifespan will be the same as what you initially requested from the user.

Keys will be active until the expiration time and date is reached, however if you “Close” the Key Request, any Keys associated with it will be revoked.


What’s Next
Did this page help you?