API ReferenceUsers
Get a user
Confirms the user exists and is reachable by the caller. Returns the user id and onboarding status — personal details are never returned. Read GET /users/{userId}/requirements for what the user still has to complete.
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
import { PaytrieAPI, configure } from '@paytrie/sdk'configure({ headers: { 'x-api-key': process.env.PAYTRIE_API_KEY! } })const { data } = await PaytrieAPI.getUser("550e8400-e29b-41d4-a716-446655440000"){ "success": true, "data": { "id": "550e8400-e29b-41d4-a716-446655440000", "accessibleBy": [ "jwt" ], "status": "initial" }}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}