kyc

Current state of an identification package order.

get/v1/kyc-packages/{orderId}

Request

  • Base URL: https://api.tvarka.pro
  • URL: https://api.tvarka.pro/v1/kyc-packages/{orderId}
  • Auth: HTTP bearer

Path parameters

orderIdstring uuid required

The order id returned when the package was created.

Response

Order state. Never carries the subject's personal data itself.

orderIdstring uuid required
status'created' | 'dossier_ready' | 'awaiting_evidence' | 'awaiting_subject' | 'subject_signed' | 'validated' | 'match' | 'mismatch' | 'attested' | 'delivered' | 'refused' | 'expired' | 'failed' required

Terminal states are delivered, mismatch, refused, expired and failed. Only delivered is billed and only delivered has an artifact.

entityCodestring required
entityNamestring
subjectRolestring required
purposestring required
createdAtstring date-time
expiresAtstring date-time
deliveredAtstring date-time
ceremonyUrlstring uri

Present while the subject still has to sign, on the link delivery path.

crossCheckOutcome'match' | 'mismatch' | 'unsupported_subject'
detailstring

Changes

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