API ReferenceUsers
Update a user's onboarding fields
Applies a partial update. Send whatever GET /users/{userId}/requirements reports as outstanding — every field is optional, so requirements can be satisfied one at a time or all at once. Returns the user id and onboarding status; read the requirements endpoint to confirm what the update satisfied.
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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
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.updateUser("550e8400-e29b-41d4-a716-446655440000", { firstName: "John", lastName: "Doe", dob: "1990-12-31", addressLine1: "123 Main St", addressLine2: "Apt 1", city: "Toronto", province: "on", postalCode: "m1b5g5", occupation: "Software Engineer", purpose: "Saving for retirement", pep: false, tpd: false, olderUserInfo: { sourceOfFunds: "string", intendedUseOfUSDC: "string", walletProvider: "string", walletAddress: "string", howDidYouHear: "string", whoReferredYou: "string", previousCryptoExperience: "string" }}){ "success": true, "data": { "id": "550e8400-e29b-41d4-a716-446655440000", "accessibleBy": [ "jwt" ], "status": "initial" }}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}