API Reference

🗝 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:

Here's a breakdown of the request parameters:

ParameterDescription
client_idThe client identifier issued by IDVerse to the customer. client_id and client_secretmust be combined and Base64 encoded in the form client_id:client_secret.
client_secretThe client identifier issued by IDVerse to the customer. client_id and client_secretmust be combined and Base64 encoded in the form client_id:client_secret.
grant_typeThe 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:

FieldDescription
access_tokenThe generated access token.
token_typeThe type of the generated token.
expires_inThe validity time of the access token, in seconds.
scopeThe scope of the access token.

📌 Need Help?

If you require assistance or encounter any issues, please don't hesitate to contact us for further support.