API Integration¶
MemberCheck provides a REST API so you can integrate screening and identity verification directly into your own systems for automated, high-volume processing. The API is available in two supported major versions, API V3 (the latest) and API V2.
API versions¶
| Version | Status | Base path |
|---|---|---|
| API V3 | Latest (recommended for new integrations) | /api/v3 |
| API V2 | Supported; planned for deprecation at a future date, to be announced | /api/v2 |
| API V1 (Classic) | Decommissioned on 7 May 2023 | N/A |
API V3 is the latest major version, introduced in Release 10.5.0. New capabilities, including the enhanced ID Verification service, are delivered through API V3. Authentication and the core screening requests are unchanged from API V2, so existing integrations can move across with minimal effort. Refer to the API Change Log for the full list of changes.
API V2 remains fully available and supported. It is planned for deprecation at a future date, which will be announced in advance to give you time to migrate. New integrations should use API V3.
API documentation and Developer Centre¶
The API reference documentation and the interactive Developer Centre (Swagger) let you explore every method and try requests directly. They are also available within the web application under the Support > API Developer Centre menu item.
The documentation and Developer Centre are hosted in each service region, and the content is identical across all of them. Use the URL for your own service region.
| Service region | Reference documentation | Developer Centre (Swagger) |
|---|---|---|
| Demo (default) | https://demo.api.membercheck.com/docs/index.html | https://demo.api.membercheck.com/swagger/index.html |
| Australia (Oceania) | https://api.membercheck.com/docs/index.html | https://api.membercheck.com/swagger/index.html |
| Germany (Europe) | https://api.eu.membercheck.com/docs/index.html | https://api.eu.membercheck.com/swagger/index.html |
| Indonesia (Asia-Pacific) | https://api.id.membercheck.com/docs/index.html | https://api.id.membercheck.com/swagger/index.html |
| GCC (Gulf) | https://api.z.membercheck.com/docs/index.html | https://api.z.membercheck.com/swagger/index.html |
Scans run in the Developer Centre count towards your quota
Most API methods require authentication with an API Access Key or Bearer token. All API scans performed in the Developer Centre count towards your organisation's scan count. If you need to test the API without impacting your scan count, please contact your Account Manager or support@membercheck.com.
Environments and regions¶
All examples in the API reference documentation use the default Demo URL. To send requests to a different environment or region, change the URL domain and check that your API key is correct for that specific region and environment. The same regional domains also host the documentation and Developer Centre listed above.
| Environment | Region | Base domain |
|---|---|---|
| Demo (default) | Australia (Oceania) | https://demo.api.membercheck.com |
| Production | Australia (Oceania) | https://api.membercheck.com |
| Production | Germany (Europe) | https://api.eu.membercheck.com |
| Production | Indonesia (Asia-Pacific) | https://api.id.membercheck.com |
| Production | GCC (Gulf) | https://api.z.membercheck.com |
Append the version path to the base domain, /api/v3 (recommended) or /api/v2. For example, the Australian production endpoint for API V3 is https://api.membercheck.com/api/v3.
The API domain is specific to your service region. You can find the API domain for your account within the Developer Centre, accessible via the Support menu once you have logged in to the web application.
API keys¶
The API keys are different for the Demo and Production environments. If you have accounts in both environments or have transferred regions, please use the environment-specific key to enable your requests to be successfully authenticated and authorised.
For information on generating an API key for your account or another user account, please refer to the API Keys guide.