active. They appear as a map on the customer object, keyed by field name, with each entry describing the status and which capabilities it affects.
For most customers with straightforward identity verification, requirements resolve automatically in under 60 seconds with no action needed. This page covers the cases where something is outstanding.
Requirements map
requirements is a map<string, Requirement> keyed by field name. The key itself is the requirement type:
Requirement statuses
Requirements in
due, rejected, or overdue states need action. Requirements in pending are being processed asynchronously.
Requirement keys and resolution
All field-based requirements resolve by submitting the corresponding field viaPOST /v2/customers/{customerId}. The only non-field key is tos.
Requirement keys use canonical field names (e.g.,
addressSubdivision, addressPostalCode), which map to the address shape in the request body (state, postCode). A requirement keyed addressSubdivision is resolved by submitting individual.address.state.The resolution loop
A typical requirements-resolution pattern:Special cases
Terms of Service
When atos requirement is present, the requirement entry includes a url with the current Terms of Service link:
- Read the
urlfromrequirements.tosand render the Terms of Service to the customer. This is required; do not skip. - Submit the acceptance:
Rejected requirements
A requirement withstatus: rejected means the submitted value failed verification. Collect the field again from the customer and resubmit via POST /v2/customers/{customerId}.
What you cannot resolve
Someinactive capability states are driven by compliance decisions that cannot be unlocked via the API:
- Sanctions matches
- Adverse media
- Manual compliance holds
Monitoring via webhooks
Subscribe tocustomer.capability.status_changed to be notified when requirements are resolved and capabilities transition. This avoids polling the customer endpoint in your integration.
Webhook event names are provisional and subject to change until the webhooks documentation ships.