Verifications API
Some of the services integrated within the Checkin.com Framework can also be used separately via our Verifications API.
More services can be enabled via the API based on your requests.
Environments
Production URL: https://external.regily.com
Test URL: https://staging-external.regily.com
Authentication
The API is fully secure and all endpoints (except the health check) requires authentication on each request.
Authorization for all requests to the external API should be done either via a header or a request body entry.
- Over HTTP Header:
x-partner-key: apiKey
- Over POST Request body:
clientToken: apiKey
API Keys
The relevant API keys are shared separately on request
Services
No Authentication Required
- Health check service: /hc
- The status check endpoint
Authentication Required
- CRUKS Service: /auth:idincrukscheck
- The endpoint to run CRUKS checks - iBAN Service: /auth:idinibancheck
- The endpoint to run iBAN checks - PEP/Sanction Service: /sanctions
- The endpoint to run PEP/Sanction lookups
See the next section for examples and descriptions of the services.
Please note: All services are enabled on partner level. In case you get code 401, you might need to get a service enabled.
HTTP Status codes
Code | Title | Description |
---|---|---|
200 | OK | The GET request was successful |
202 | OK | The POST request was successful |
400 | Bad Request | Something is wrong with your request |
401 | Unauthorized | Your API key is invalid or wrong |
404 | Not Found | The resource does not exist |
429 | Too Many Requests | The rate limit was exceeded |
500 | Internal Server Error | An error occurred |
Updated over 2 years ago