🗝 Learn how to securely obtain an access token.
An access token is required to create Face Access challenges, and to retrieve challenge statuses. Tokens are valid for 60 mins. Use the POST - Get an OAuth2 Access Token
endpoint to obtain the access token.
Below is the request example to obtain an access token:
curl --request POST \
--url https://oauth.au.faceaccess.io/token \
--header 'accept: application/json' \
--header 'authorization: Basic client_id:client_secret' \
--header 'content-type: application/json' \
--data '
{
"grant_type": "client_credentials"
}
Note
We offer FaceAccess service across multiple regions. Be sure to use the correct Base URL for your integration:
- Australia (AU): https://oauth.au.faceaccess.io
- Canada (CA): https://oauth.ca.faceaccess.io
- United Kingdom (UK): https://oauth.uk.faceaccess.io
- United States (US): https://oauth.us.faceaccess.io
Here's a breakdown of the request parameters:
Parameter | Description |
---|---|
client_id | The client identifier issued by IDVerse to the customer. client_id and client_secret must be combined and Base64 encoded in the form client_id:client_secret . |
client_secret | The client identifier issued by IDVerse to the customer. client_id and client_secret must be combined and Base64 encoded in the form client_id:client_secret . |
grant_type | The token grant type, or permission, the value should be client_credentials |
An example response:
{
"access_token": "eyJ0eXAiO[SNIP]49QOZmc",
"token_type": "bearer",
"expires_in": 3599,
"scope": ""
}
Here are the details of the response fields:
Field | Description |
---|---|
access_token | The generated access token. |
token_type | The type of the generated token. |
expires_in | The validity time of the access token, in seconds. |
scope | The scope of the access token. |