Introduction
The Management APIs allow you to retrieve admin events, manage user devices, and send users a link that initiates a BindID registration flow.
Base URL
The Management API is served over HTTPS, and provided as endpoints under:
where <host-name> has the following value depending on the environment:
- Sandbox:
admin.bindid-sandbox.io
- Production:
admin.bindid.io
- Production EU:
admin.eu.bindid.io
Authorization
An access token can be created by calling the /token endpoint, using API credentials generated via the Admin Portal from Settings > API Credentials. Access tokens are valid for 30 days.
The Authorization
header value should have the following form:
Errors
The following types of errors will be returned in case of failure.
Unauthorized
For an API call specifying an invalid header access token or one that does not belong to the body credentialsId
, the response will be an HTTP 401 Unauthorized response:
Others
API calls may return other failure responses, such 400 Bad Request
errors when the request is incorrectly formatted. All APIs may also return a 500 error in case of an internal server error.