compliance

Screen

Pre-payment recipient screen. Returns a SAMLA-compliant verdict.

post/compliance/screen

Request

  • Base URL: https://api.algovoi.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://api.algovoi.co.uk/compliance/screen
  • Auth: none declared

Request body

recipient_addressstring required
networkstring required
amount_microunitsinteger nullable
assetstring nullable

Response

Successful Response

verdict'allow' | 'block' | 'flag' required
sanctions_clearboolean required
recipient_kyb_status'unknown' | 'trial' | 'approved' | 'rejected' required
risk_tier'low' | 'medium' | 'high' | 'restricted' | 'unknown' required
reasonsstring[] required
screened_atstring required
verdict_idstring required
network_normalisedstring required
tipping_off_noticestring
action_refstring nullable
compliance_receiptobject nullable
compliance_receipt_jwsstring nullable
compliance_receipt_pefobject nullable
compliance_basis_refstring nullable
compliance_basis_binding_refstring nullable
compliance_basis_evidenceobject nullable
request_signature_verifiedboolean nullable
request_signature_keyidstring nullable
request_signer_identity_anchoredboolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.