Endpoints
| Endpoint | Request |
|---|---|
| List Verifications | GET /verifications |
| Create Verification | POST /verifications |
| Retrieve Verification | GET /verifications/{verification_id} |
| Update Verification | PATCH /verifications/{verification_id} |
| Delete Verification | DELETE /verifications/{verification_id} |
Attributes
ISO 3166-1 alpha-2 country code (e.g.
US, GB). For individuals this is the
country of citizenship or residence reported by the identity provider; for
businesses this is the country of incorporation.The verification ID, e.g. idpf_*
Available options:
individual, businessThe outstanding information this verification still needs — payout RFIs and audit RMIs, one uniform shape.
Properties
Properties
Additional guidance for the field beyond the label.
The reason a previously submitted value was rejected, or null.
Stable snake_case key for the field (e.g. ssn, business_description).
The requested information item id (inrqi_*). Use this when answering.
Human-readable label for the field (e.g. “Social Security Number”).
Upload slots for a files item — always at least one when type is
files, empty otherwise.Properties
Properties
Identifier to send back with the uploaded file so it routes correctly; null
for a generic upload.
Whether this slot can be left empty.
Provider-specific document kind, when applicable.
Label for this upload slot (e.g. “Front of ID Document”).
Whether this slot accepts more than one file.
How to render the input: text, date, phone, address, or files.
Available options:
not_started, pending, approved, rejected,
action_requiredVerification

