Webhook-based Approach

➊ Consume Documents Required Events
Setup a Webhook Consumer to receiveidentity.documents_required
events for your end users.
➋ Fetch Required Documents
Call Get Event to fetch the event’sidentity_documents_required
object, which will allow you to understand which documents are required.
➌ Upload the Required Documents
For the event’s associatedidentity_id
, call Document Upload to upload the required documents, either synchronously if you already have the documents, or asynchronously if you need to reach back out to your customer for them to provide.
➍ Wait for Approval or Denial
This will be followed by anidentity.approved
or identity.denied
event based on the onboarding decision for that end user (this might take up to 1 full business day to complete).
Polling-based Approach
➊ Poll for Documents Required Events
Poll List Events, offsetting thecreated_at.gt
filter for each subsequent poll, fetching all identity.documents_required
events.
Paxos recommends you keep track of the Event ids you’ve processed in order to idempotently process the event.
➋ Upload the Required Documents
For the event’s associatedidentity_id
, call Document Upload to upload the required documents, either synchronously if you already have the documents, or asynchronously if you need to reach back out to your customer for them to provide.