Retrieve current KYX check status / outcome.
GET/v1/parties/kyx/:arkVerificationId
This endpoint retrieves the current KYX check status.
The KYX status will stay in IN_PROGRESS status whilst a check is in progress. Once an outcome has been
determined, the relevant KYX check status will change in the response to one of the following:
VERIFIED- The party has passed the KYX check and will advance toVERIFIEDstatusFAILED- The party has failed the KYX check. A new check can be initiated from this state.ERRORED- The party has failed the KYX check. A new check can be initiated from this state.UNDER_REVIEW- The KYX check is still in progress but requires manual intervention to complete.DECLINED- The party has failed the KYX check due to numerous possible reasons (PEP or watchlist hit, etc.). The party can transition toTERMINATEDstatus based on this outcome.
The party can only advance to ACTIVE status if the outcome of the KYX check is VERIFIED. Any other
outcome will result in the party status remaining at PROSPECT.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 500
- 503
Returns the current KYX check status / outcome details.
If the returned status is VERIFIED, the party will transition to VERIFIED
and is now eligible to be onboarded to the core system.
Ark Verification ID in header does not match Ark Verification ID in path (PAR000005). Missing required "arkVerificationId" header (PAR000009). Schema validation error (GEN000000).
Missing or invalid authentication token (GEN001002) or Role unauthorized (GEN001006) or Tenant context could not be resolved (AUT001001)
External application access denied (AUT003001)
No open binding for the verification (CRT004005) or KYX record not found (PAR004006)
Invalid party status transition (PAR022001)
Internal server error (GEN100000). Service error (GEN100001). An error occurred while communicating with the identity verification connector (PAR100013).
All connector targets are currently unhealthy (CRT103001)