Skip to main content
GET
/
v1
/
users
/
{userId}
/
kyc
Get KYC
curl --request GET \
  --url https://api.cadanapay.com/v1/users/{userId}/kyc \
  --header 'Authorization: Bearer <token>'
{
  "idDetails": {
    "country": "NG",
    "type": "Passport"
  },
  "identity": "approved",
  "address": "approved",
  "firstName": "John",
  "lastName": "Doe",
  "identityStatusReason": "ID is expired",
  "addressStatusReason": "Name on the address does not match the name on the ID"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

​
userId
string<uuid>
required

The unique identifier for the user

Response

get user kyc response

​
idDetails
object
​
identity
enum<string>

kyc status

Available options:
not started,
processing,
approved,
rejected
Example:

"approved"

​
address
enum<string>

kyc status

Available options:
not started,
processing,
approved,
rejected
Example:

"approved"

​
firstName
string

Person's first name on ID

Example:

"John"

​
lastName
string

Person's last name on ID

Example:

"Doe"

​
identityStatusReason
string

Reason for rejecting an ID

Example:

"ID is expired"

​
addressStatusReason
string

Reason for rejecting an address

Example:

"Name on the address does not match the name on the ID"