How ezyshield works
Organizations, verifications, checks, webhooks, and ABA checks.
Create your first verification
Create a verification, receive completion events, and store the verification ID.
Choose a confirmation mode
Decide whether the contact should complete KYC, biometric confirmation, or no contact confirmation.
API reference
Endpoint fields, response schemas, authentication, pagination, and errors.
What to build first
Build the verification path first. A useful first integration usually does four things:Create an API key
Create a key in the Dashboard with the abilities this integration will need. API key abilities are chosen when the key is created; if you need different abilities later, create a new key.
verification:read and verification:write are enough to create and retrieve verifications. Webhook subscription abilities are only needed if your app will create or manage webhook subscriptions through the API.Confirm your organization
Call Get the current organization to confirm the key works and belongs to the organization you expect.
Create a verification
Send business, contact, and bank account details to Create a verification. Store the returned verification ID in your system.
Listen for completion
Use webhooks as the normal completion path. Polling is useful while debugging, but production integrations should react to events.