Get KYC Profile

get/api/accounts/{accountId}/kyc-profile

Get a KYC profile by account id if it exists.

Request

Path Parameters

accountIdstringrequired
Id of the cardholder or identity account.

Query Parameters

includePersonalDetailsbooleandefault: false
Include personal details (name, date of birth, etc) in the response. Requires additional permissions.

Response

Successful operation.

Body application/json

idstring
The KYC profile id.
accountIdstring
The account id.
statusstring
Allowed values:createdpendingpassingpassedfailingfailed
The status of the KYC profile.
regionstring
Region code.
createdAtstring
Timestamp of KYC profile creation.
createdBystring
The Immersve Resource Name (IRN) that created the resource.
modifiedAtstring
Timestamp of this KYC profile modification.
modifiedBystring
The Immersve Resource Name (IRN) that modified the resource.

Subject is not allowed to perform the action with the reason stated in the errorCode.

FORBIDDEN Account does not exist or there are no sufficient permissions to view KYC profile for this account.

KYC_PROFILE_DOES_NOT_EXIST KYC profile does not exist for this account. It gets created upon initiating the first KYC check.

LIVENESS_MISMATCH Resource liveness does not match request liveness.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/accounts/{accountId}/kyc-profile' \
  --header 'Authorization: Bearer <access-token>'

Example Response

{
  "id": "afd4772562be47f8a3467a11d06c96ba",
  "accountId": "225d85e65495722bf6517ea0ba0d6f56",
  "status": "created",
  "region": "NZ",
  "createdAt": "2022-11-16T03:13:18.142Z",
  "createdBy": "irn:314d85e65495722bf6517ea0ba0d4lp3:api-key:SLOs3U38hdhfEqwF1JKpTw",
  "modifiedAt": "2022-11-16T03:13:18.142Z",
  "modifiedBy": "irn:314d85e65495722bf6517ea0ba0d4lp3:api-key:SLOs3U38hdhfEqwF1JKpTw"
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}