This guide is for developers connecting their own system to APLYiD. If you use a practice management system or CRM that already integrates with APLYiD, see Integrating with APLYiD instead.
1. Get access to the test environment
To get access to our UAT (test) environment, contact your Customer Success Manager. They'll set up a test account so you can build and test your integration before going live.
2. Get your API credentials
Once your account is set up:
Log in to the APLYiD portal as a Company Admin.
Go to Preferences → Developers.
Copy your API Key and Secret.
If the Developers page is empty, contact your Customer Success Manager or support@aplyid.com and we'll issue your credentials.
Treat your API key and secret like a password. Don't share them publicly or store them in client-side code.
3. Build your integration
Follow our API documentation at docs.aplyid.com. It covers authentication, endpoints, request and response formats, and webhook event types.
4. Set up webhooks
Webhooks let APLYiD notify your system when a verification changes status or is completed.
In the APLYiD portal, go to Preferences → Developers.
Enter your webhook URL.
Choose an authentication method and enter your credentials or token.
Save, then send a test ping to check the connection.
Webhook requirements
Your endpoint must accept HTTP POST requests in JSON format.
Supported authentication: Basic, Digest or Bearer token.
Any 2xx or 3xx response is treated as successful.
Retries
If your endpoint returns a 400-level or 500-level response, we retry up to eight times with increasing delays, over roughly five hours from the first attempt. Retries happen at about 1, 6, 18, 40, 75, 126, 196 and 288 minutes after the original event.
Restricting by IP address
If you want your webhook endpoint to only accept requests from APLYiD, here are the IP addresses that our production events are sent from: https://docs.aplyid.com/overview/environments.html#our-ip-addresses
5. Go live
When you've finished testing, contact your Customer Success Manager to move to production. Remember to update your integration to use your production credentials and URLs.
Troubleshooting
I get an authentication or "bad credentials" error
Check that the API key and secret were copied in full, with no extra spaces.
Check that you're using the right credentials for the environment (test or production).
If your account has an IP or domain allow list, make sure the server making the requests is on it.
Check with your Customer Success Manager and make sure that the API are enabled on your account.
The webhook test ping fails
Check the URL for typos, or a section that has been pasted twice.
Check that the authentication method and token match what your endpoint expects.
Make sure your endpoint is publicly reachable and returns a 2xx response.
I'm not receiving webhook events
Send a test ping from Preferences → Developers to confirm the connection.
Check your server logs for failed or rejected requests.
Need help?
Test environment access or going live: your Customer Success Manager
API documentation: docs.aplyid.com
Technical issues: Live Chat in the APLYiD portal, or support@aplyid.com