Submit a compliance check result
Submit the result of an async verification flow (e.g. Persona inquiry
SDK, Dojah widget) as an alternative to webhook-based completion.
provider_payload carries the provider’s callback/completion data.
Authorizations
HTTP Basic Authentication using the API Key as username and API Secret as password.
Path Parameters
The prefixed public id of the investor (e.g. inv_…).
Body
The compliance workflow ID returned in the compliance_checks array during account creation.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
The type of compliance check being submitted. Must match one of the checks returned during account creation.
identity_verification, tax_id_verification, screening, business_verification "identity_verification"
Provider-specific callback/completion payload. Contents depend on the provider:
- Persona: Include the inquiry/transaction completion data (e.g.,
event_type,inquiry_id,status). - Dojah: Include the widget completion data (e.g.,
verification_status,reference_id).
Response
Check result processed successfully.
The compliance workflow this check belongs to.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
The type of compliance check performed.
identity_verification, tax_id_verification, screening, risk_assessment, business_verification "identity_verification"
Current status of the check:
pending— Async verification in progress; useverification_urlorverification_tokenfor user completion.clear— Verification passed.failed— Verification failed.review_required— Manual review needed (e.g., potential PEP/sanctions match).error— Provider error during verification.
pending, clear, failed, review_required, error "pending"
The verification provider handling this check (e.g., persona-identity, persona-taxid, dojah).
"persona-identity"
Provider-specific reference ID for the verification.
"inq_abc123def456"
User-facing verification URL for async checks, when available.
"https://withpersona.com/verify?inquiry-id=inq_abc123def456"
Provider token or SDK configuration for client-side verification, when available.
null