Create Users

Overview

Users can be either individuals or businesses.

User Types

Sentra supports two types of users:

• INDIVIDUAL - Personal accounts for individual users
• BUSINESS - Business accounts for companies and organizations

Creating a User

To create a user, you'll need to provide:

• A unique UUID as the user ID
• Email address
• User type (INDIVIDUAL or BUSINESS)
• Capabilities: specify the regions for which the user should be verified (accepted values: "USD", "AED", "OTHER"). If not provided, verification will be done for all supported regions.

Example Request

POST /users
Content-Type: application/json
X-API-KEY: sk_dev_your_api_key

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "type": "INDIVIDUAL",
  "capabilities": ["USD", "OTHER"]
}

Example Response

The response includes a kycUrl, which can be used to redirect the user to complete their KYC/B process.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "firstName": null,
  "middleName": null,
  "lastName": null,
  "businessName": null,
  "type": "INDIVIDUAL",
  "kycStatus": "NOT_STARTED",
  "kycUrl": <string>,
  "phoneNumber": null,
  "phoneCountryCode": null,
  "address": null,
  "metadata": null,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Verification Status

Every user has a verification status that tracks their compliance progress. Individuals go through KYC (Know Your Customer) while businesses complete KYB (Know Your Business):

• NOT_STARTED - Verification hasn't been initiated
• STARTED - Verification process has begun
• SUBMITTED - Required documents have been submitted
• UNDER_REVIEW - Submission is under compliance review
• REJECTED - Verification was rejected
• APPROVED - Verification approved (required to process payments)

Retrieving Users

Get a Specific User

GET /users/{id}
X-API-KEY: sk_dev_your_api_key

Get All Users

GET /users
X-API-KEY: sk_dev_your_api_key

Best Practices

Next Steps