API ReferenceUsers
Get a user's onboarding and compliance requirements
Reports what the user still has to do before they can transact. Submit the outstanding fields with PATCH /users/{userId}, then read this again — it is the authoritative view of what remains.
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
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.getUserRequirements("550e8400-e29b-41d4-a716-446655440000"){ "success": true, "data": { "requirements": { "emailVerification": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" }, "phoneVerification": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" }, "disclosure": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" }, "personalInfo": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" }, "address": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" }, "occupation": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" }, "additionalInfo": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" }, "kyc": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" }, "kycRefresh": { "status": "pending", "requiredFields": [ "olderUserInfo.sourceOfFunds", "olderUserInfo.intendedUseOfUSDC" ], "reason": "documentUploadRequired" } }, "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" } ]}