Paytrie Developer Documentation
API ReferenceUsers

Get the user's onboarding and compliance requirements

GET
/users/me/requirements

Authorization

ApiKeyAuth BearerAuth
x-api-key<token>

API key for integrator authentication

In: header

AuthorizationBearer <token>

JWT token for user authentication

In: header

Header Parameters

x-api-key*string

API key for authentication

Authorization*string

JWT token from login endpoints

Response Body

application/json

application/json

application/json

application/json

import { PaytrieAPI, configure } from '@paytrie/sdk'configure({ headers: { 'x-api-key': process.env.PAYTRIE_API_KEY! } })const { data } = await PaytrieAPI.getCurrentUserRequirements()
{  "success": true,  "data": {    "pending": [      "phoneVerification",      "kyc"    ],    "processing": [],    "satisfied": [      "emailVerification",      "personalInfo",      "address",      "occupation"    ]  }}
{  "success": false,  "errors": [    {      "field": "string",      "message": "string"    }  ]}
{  "success": false,  "errors": [    {      "field": "string",      "message": "string"    }  ]}
{  "success": false,  "errors": [    {      "field": "string",      "message": "string"    }  ]}