Paytrie Developer Documentation
API ReferenceUsers

Generate a KYC verification URL

GET
/users/{userId}/kyc-url

Authorization

ApiKeyAuth BearerAuth
x-api-key<token>

API key for integrator authentication

In: header

AuthorizationBearer <token>

JWT token for user authentication

In: header

Path Parameters

userId*string

Header Parameters

x-api-key*string

API key for authentication

Authorization*string

JWT token from login endpoints

Response Body

application/json

application/json

import { PaytrieAPI, configure } from '@paytrie/sdk'configure({ headers: { 'x-api-key': process.env.PAYTRIE_API_KEY! } })const { data } = await PaytrieAPI.getUserKycUrl("550e8400-e29b-41d4-a716-446655440000")
{  "success": true,  "data": {    "url": "https://...",    "expiresAt": "2024-01-01T00:30:00.000Z"  }}
{  "success": false,  "errors": [    {      "field": "string",      "message": "string"    }  ]}