v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Sandbox Identity

Sandbox Set Identity Status

Set the various statuses for the given Identity. To enable the Person Identity to transact, set both id_verification_status and sanctions_verification_status to "APPROVED". To enable the Institution to transact, set both sanctions_verification_status to "APPROVED". This endpoint also allows you to set the statuses for document_verification_status and additional_screening_status

put/identity/identities/{id}/sandbox-status

Path parameters

idstring required

Request body

id_verification_status'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED'
sanctions_verification_status'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED'
document_verification_status'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED'
additional_screening_status'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED'

Example request

{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "id_verification_status": "APPROVED",
  "sanctions_verification_status": "APPROVED"
}

Response

A successful response.

SandboxSetIdentityResponse required