Get a KYC profile
GET/api/accounts/:accountId/kyc-profile
Get a KYC profile by account id if it exists.
Request
Path Parameters
accountId stringrequired
Id of the account.
Example: 225d85e65495722bf6517ea0ba0d6f56
Responses
- 200
- 403
- application/json
- Schema
- Example (from schema)
Schema
id string
The KYC profile id.
accountId string
The account id.
status string
The status of the KYC profile.
region string
Region code.
createdAt string
Timestamp of KYC profile creation.
createdBy string
The Immersve Resource Name (IRN) that created the resource.
modifiedAt string
Timestamp of this KYC profile modification.
modifiedBy string
The Immersve Resource Name (IRN) that modified the resource.
{
"id": "afd4772562be47f8a3467a11d06c96ba",
"accountId": "225d85e65495722bf6517ea0ba0d6f56",
"status": "passed",
"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"
}
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.
- application/json
- Schema
- Example (from schema)
Schema
statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string
{
"statusCode": 403,
"statusName": "Forbidden",
"errorCode": "FORBIDDEN",
"reason": "Unauthorized"
}
Loading...