KYC document

KYC document

curl --request GET \
  --url https://api.example.com/api/v1/auth/kyc/document/me

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/auth/kyc/document/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

GET

api

auth

kyc

document

KYC document

curl --request GET \
  --url https://api.example.com/api/v1/auth/kyc/document/me

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/auth/kyc/document/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Requires Authorization: Bearer <user-access-token> — the token from Verify login code. No X-Api-Key/X-Api-Secret needed; this is a post-login endpoint.

Returns the government ID document data extracted during the user’s Persona identity verification, along with the inquiry ID and current KYC status. Use this to display document details in a user-facing verification summary screen.

Request

GET /api/v1/auth/kyc/document/me
Authorization: Bearer <user-access-token>

No body or query parameters.

Response

200 OK

{
  "success": true,
  "data": {
    "inquiryId": "inq_abc123xyz",
    "kycStatus": "approved",
    "document": {
      "issuingCountry": "MX",
      "type": "passport",
      "issuedDate": "2018-03-10",
      "idNumber": "A1234567",
      "expiryDate": "2028-03-10",
      "imageFront": null,
      "imageBack": null
    }
  }
}

Field	Type	Description
`inquiryId`	string	Persona inquiry ID
`kycStatus`	string	Current KYC status — see KYC status values
`document.issuingCountry`	string \| null	ISO 3166-1 alpha-2 country that issued the document
`document.type`	string \| null	Document type as extracted by Persona
`document.issuedDate`	string \| null	Issue date — `YYYY-MM-DD`
`document.idNumber`	string \| null	Document number
`document.expiryDate`	string \| null	Expiry date — `YYYY-MM-DD`
`document.imageFront`	string \| null	Front image URL if available
`document.imageBack`	string \| null	Back image URL if available

Errors

HTTP status	Error	Cause
`401`	`Invalid or expired token`	Missing, expired, or malformed access token
`404`	`KycVerification not found: <userId>`	No KYC verification has been initiated — call `POST /partner/kyc` first

Exchange rates / TRM

Cards

Users

Login

User profile

KYC

Account Management

Financials

Request

Response

Errors

​Request

​Response

​Errors

Request

Response

Errors