Skip to main content
GET
/
api
/
v1
/
members
/
{userId}
/
kyc
Get KYC status and documents
curl --request GET \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/kyc \
  --header 'x-tenant-api-key: <api-key>'
{
  "status": "<string>",
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "documentType": "<string>",
      "fileName": "<string>",
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "mimeType": "<string>",
      "fileSize": 123,
      "rejectionReason": "<string>",
      "reviewedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider": "<string>",
  "providerApplicantId": "<string>",
  "verifiedAt": "2023-11-07T05:31:56Z",
  "rejectionReason": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-tenant-api-key
string
header
required

Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.

Path Parameters

​
userId
string<uuid>
required

Response

Member KYC status

​
status
string
required
​
documents
object[]
required
​
id
string<uuid>
​
provider
string | null
​
providerApplicantId
string | null
​
verifiedAt
string<date-time> | null
​
rejectionReason
string | null
​
createdAt
string<date-time> | null
​
updatedAt
string<date-time> | null