This guide is for developers connecting to the APLYiD Core API. If you use APLYiD through a CRM (e.g. Rex, Vault, Eagle, Box and Dice), contact Workflow Support instead. For Zapier, FormsByAir and similar platforms, see My integration isn't working (OneLaw, Rex, Zapier, FormsByAir and others).
Quick answer
Most API problems come from one of these:
API access hasn't been switched on for your account yet
Using live credentials on the test environment, or test credentials on live
Allowed IPs or Allowed domains in Preferences > Developers are blocking your requests
Your firewall is blocking webhooks from APLYiD
Calling an endpoint or API version that doesn't exist
Check the table below for the fix. For full technical details, see the APLYiD API documentation.
Where to find your API settings
Log in to APLYiD and go to Preferences > Developers. Here you'll find your API credentials, your Allowed IPs and Allowed domains, and your webhook settings.
Test and live environments
| Test | Live |
Address | integration.aplyid.com | app.aplyid.com |
Account | A separate account. Contact your Customer Success Manager to set it up. | Your normal APLYiD account |
Credentials | Its own API credentials | Its own API credentials |
Credentials only work in the environment they were created in. Live credentials on the test environment (or the other way round) return an authentication error.
Common problems and how to fix them
What you see | Likely cause | What to do |
401 or 403 error, even though your credentials are correct | API access isn't switched on for your account yet | Contact us and we'll enable API access. |
401 error or authentication failed ( | Credentials from the wrong environment, or missing/incorrect authentication headers | Check you're using the right credentials for the environment (see above). Check your headers match the API documentation. |
Requests are rejected after you added Allowed IPs or Allowed domains | Once you add any entry, every IP or domain not on the list is blocked | Clear both lists in Preferences > Developers, test again, then add your entries back one at a time. |
Webhooks aren't arriving | Your firewall or security service (e.g. Cloudflare) is blocking APLYiD | Add APLYiD's IP addresses to your allowlist. You'll find them in the API documentation. Also check your webhook settings in Preferences > Developers. |
No webhook or report for a particular verification | Your client hasn't completed the verification. No report is created until they do. | Check the verification's status in the portal. Links expire after 7 days. |
Endpoint not found | Calling an endpoint or API version that doesn't exist (e.g. | To send a biometric verification by SMS, use the v2 |
400 error with | The SMS couldn't be sent, usually because of the mobile number's format | Check the mobile number and country code. If it still fails, contact us with the details below. |
Can't get the report for a completed verification | It has been archived. Completed verifications are archived 7 days after completion or 1 hour after the report is downloaded, whichever comes first. | Download and store the report as soon as you receive the webhook. |
What to send us if you're still stuck
Contact us through live chat or support@aplyid.com and include:
Which environment (test or live)
The endpoint and API version you called
The date and time of the request, with your time zone
The full error response (HTTP status and error code)
The verification reference, if there is one
Never send your API secret by email or live chat.
Frequently Asked Questions
Is there a test environment?
Yes. Contact your Customer Success Manager so they can set you up with your credentials.
Can I download the PDF report through the API without reviewing it first?
By default, verifications that need review must be reviewed in the portal first. This can be switched off for your account.
Can webhooks include the results from each data source?
Yes, with the Advanced ASF add-on. Contact your Customer Success Manager to find out more.
Can you whitelist our IP address?
You can add your own IPs under Allowed IPs in Preferences > Developers. If you need help, contact us.