Sign in
KYC Requirements

Create KYC requirement

Creates a new KYC requirement linking an AccountHolder to a LegalEntity verification action.

The natural key is (account_holder_id, legal_entity_id, scope, requirement_type) — only one requirement per combination is allowed. Optionally provide kyc_requirement_number for an opaque external SoE ID (must be unique per tenant when present).

post/api/kyc-requirements

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/kyc-requirements
  • Auth: none required

Request body

account_holder_idstring uuid required
deadlinestring date nullable
document_idstring uuid nullable
kyc_requirement_numberstring nullable
legal_entity_idstring uuid required
requirement_type'identity_document' | 'proof_of_address' | 'source_of_funds' | 'business_relationship' | 'pep_declaration' | 'ubo_declaration' | 'purpose_of_payment' required
scope'account_holder' | 'counterparty' | 'payment_account' | 'beneficial_owner' required
status'pending' | 'submitted' | 'under_review' | 'approved' | 'rejected' | 'expired' nullable
tenant_idstring uuid required

Example request

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "deadline": "2020-04-20",
  "document_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "kyc_requirement_number": "",
  "legal_entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "requirement_type": "identity_document",
  "scope": "account_holder",
  "status": "pending",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.