POST /auth/onboarding

Use this API to onboard a new user.

This API is used by an organization to onboard new users to the platform. Accounts registered in this way can skip a few steps of the KYC process. The response carries the new user's id; the organization can act for that user with its own organization key by passing memberId to mint-request, add-bank-account and redeem-request, so it does not need to store the user's apiKey and apiSecret. The organization key can list its users and read their transaction history; it cannot read their bank accounts. This endpoint accepts requests of type multipart/form-data.

Parameters

1. email (String):

   This parameter represents the email address of the user.

2. fullname (String):

   This parameter refers to the user's full name.

3. address (String):

   This parameter refers to the user's physical address.

4. idNumber(String):

   This parameter refers to the user's ID number.

5. idFile(File): This parameter represents an image file of the user's ID. Accepted file types are: jpeg, png, jpg, webp. File dimension should be between 256px * 256px and 4096px * 4096px.

Example Request

curl -X POST '<https://api.idrx.co/auth/onboarding>' --header 'idrx-api-key: <API_KEY>' --header 'idrx-api-sig: <signature>' --header 'idrx-api-ts': <timestamp>' --header 'Content-Type': multipart/form-data'

Payload

{
  "email": "string",
  "fullname": "string",
  "address": "string",
  "idNumber": "string",
  "idFile": "file"
}

Response

If the request is successful, the response will be as shown below:

{
  statusCode: 201,
  message: 'success',
  data: {
    id: 1011,
    fullname: 'JOHN SMITH',
    createdAt: '2023-12-12T08:10:29.077Z',
    apiKey: '3d1c15c7afd157a6',
    apiSecret: '7bb0de01a2cf17c1094db789bfa05eb1adc185482c3ee828a7ba61b683e9b711'
  }
}