API ReferenceUsers
Import KYC data for a user
Import KYC data for a user from a share token. Currently only supports importing using Sumsub Shared KYC. Returns the user id and onboarding status; read GET /users/{userId}/requirements to confirm the KYC requirement is 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
import { PaytrieAPI, configure } from '@paytrie/sdk'configure({ headers: { 'x-api-key': process.env.PAYTRIE_API_KEY! } })const { data } = await PaytrieAPI.importUserKyc("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" } ]}{ "success": false, "errors": [ { "field": "string", "message": "string" } ]}