Skip to main content

List KYX document metadata.

GET 
/v1/parties/kyx/:arkVerificationId/documents

Retrieve KYX document metadata for the current KYX verification.

Integration notes:

  • arkVerificationId is the platform KYX checkId (UUID) returned by POST /v1/parties/kyx.
  • This endpoint returns metadata only (no document files and no provider source IDs).
  • Current mapped document types are PASSPORT, DRIVERS_LICENSE, and MEDICARE_CARD.
  • verificationReasonCode is optional and only present when returned by the provider.
  • Requires OAuth2 bearer token plus clientid and brandid headers.
  • A service verification mapping must exist for the supplied arkVerificationId.

Response element mapping for callers:

  • arkVerificationId: The platform KYX check identifier the result belongs to.
  • data[]: One object per mapped provider source/document that has a non-empty source and a matching provider result.
  • data[].documentType: The normalized Ark document type for the source (for example, PASSPORT, DRIVERS_LICENSE, MEDICARE_CARD).
  • data[].verificationStatus: Raw provider state for that document/source (for example, IN_PROGRESS, VERIFIED, FAILED).
  • data[].verificationStatusCategory: Ark normalized status group (PENDING, VERIFIED, FAILED, ERRORED) for caller workflow logic.
  • data[].verificationReasonCode: Optional provider reason code for the state (for example, NC_DVS_D); can be absent.
  • data[].verificationDetails.checks[]: Provider field-level check details for diagnostics or UI display.
  • data[].messages[]: Optional provider messages mapped from document result extra data.

Error scenario coverage:

  • Platform OAS intentionally covers service scenarios (400, 401, 404, 500) plus platform-specific scenarios (403, 501).

Request​

Responses​

KYX document metadata for the supplied arkVerificationId. Each data[] item is the mapped result for a document source that was submitted and matched to a provider result.

Last updated on