KYC Requirements

Get KYC requirement by ID

Returns a single KYC requirement.

get/api/kyc-requirements/{id}

Request

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

Path parameters

idstring uuid required

KYC requirement ID

Response

KYC requirement

account_holder_idstring uuid required
deadlinestring date nullable
document_idstring uuid nullable
idstring uuid
inserted_atstring date-time
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
updated_atstring date-time

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "deadline": "2020-04-20",
  "document_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "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",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

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