Create user

curl --request POST \
  --url https://sandbox.api.reap.global/users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Reap-Version: <reap-version>' \
  --data '
{
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "termsAcceptance": {
    "version": "2026-01-17",
    "ipAddress": "192.168.1.1"
  },
  "firstName": "<string>",
  "lastName": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'POST',
  headers: {
    'Reap-Version': '<reap-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'jsmith@example.com',
    phoneNumber: '<string>',
    termsAcceptance: {version: '2026-01-17', ipAddress: '192.168.1.1'},
    firstName: '<string>',
    lastName: '<string>',
    companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://sandbox.api.reap.global/users/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://sandbox.api.reap.global/users/"

payload = {
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "termsAcceptance": {
        "version": "2026-01-17",
        "ipAddress": "192.168.1.1"
    },
    "firstName": "<string>",
    "lastName": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Reap-Version": "<reap-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "firstName": "John",
  "lastName": "Doe",
  "country": "US",
  "dateOfBirth": "1990-05-15",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application": {
    "status": "NOT_STARTED",
    "rejectionReason": "<string>",
    "documents": [
      {
        "type": "IDENTITY",
        "status": "PENDING"
      }
    ]
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "detail": {}
  }
}

POST

users

Create user

curl --request POST \
  --url https://sandbox.api.reap.global/users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Reap-Version: <reap-version>' \
  --data '
{
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "termsAcceptance": {
    "version": "2026-01-17",
    "ipAddress": "192.168.1.1"
  },
  "firstName": "<string>",
  "lastName": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'POST',
  headers: {
    'Reap-Version': '<reap-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'jsmith@example.com',
    phoneNumber: '<string>',
    termsAcceptance: {version: '2026-01-17', ipAddress: '192.168.1.1'},
    firstName: '<string>',
    lastName: '<string>',
    companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://sandbox.api.reap.global/users/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://sandbox.api.reap.global/users/"

payload = {
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "termsAcceptance": {
        "version": "2026-01-17",
        "ipAddress": "192.168.1.1"
    },
    "firstName": "<string>",
    "lastName": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Reap-Version": "<reap-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "firstName": "John",
  "lastName": "Doe",
  "country": "US",
  "dateOfBirth": "1990-05-15",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application": {
    "status": "NOT_STARTED",
    "rejectionReason": "<string>",
    "documents": [
      {
        "type": "IDENTITY",
        "status": "PENDING"
      }
    ]
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "detail": {}
  }
}

Authorizations

Authorization

string

header

required

API key as Bearer token

Headers

Reap-Version

enum<string>

required

API version (YYYY-MM-DD)

Available options:

2025-02-14

Example:

"2025-02-14"

Body

Request body for creating a new user

string<email>

required

User email address (max 50 characters)

Maximum string length: 50

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example:

"john.doe@partner.io"

phoneNumber

string

required

Phone number in E.164 format (e.g., +14155552671)

Pattern: ^\+[1-9]\d{6,14}$

Example:

"+14155552671"

termsAcceptance

object

required

Terms acceptance is required for compliance

Show child attributes

firstName

string

User first name (1-100 characters). Optional - auto-populated from the verified KYC identity on application approval if omitted.

Required string length: 1 - 100

Example:

"John"

lastName

string

User last name (1-100 characters). Optional - auto-populated from the verified KYC identity on application approval if omitted.

Required string length: 1 - 100

Example:

"Doe"

companyId

string<uuid>

Company ID (required in CORPORATE program mode)

Response

User resource

string<uuid>

required

Unique user identifier

string<email>

required

User email address

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example:

"john.doe@example.com"

phoneNumber

string

required

Phone number in E.164 format

Example:

"+14155552671"

firstName

string | null

required

User first name. Null until provided by the client or backfilled from the verified KYC identity on approval.

Example:

"John"

lastName

string | null

required

User last name. Null until provided by the client or backfilled from the verified KYC identity on approval.

Example:

"Doe"

country

string | null

required

ISO 3166-1 alpha-2 country code

Required string length: 2

Example:

"US"

dateOfBirth

string | null

required

Date of birth in YYYY-MM-DD format (populated from KYC)

Example:

"1990-05-15"

companyId

string<uuid> | null

required

Company ID (set in CORPORATE program mode)

application

object

required

KYC application status

Show child attributes

createdAt

string

required

ISO 8601 timestamp of creation

Example:

"2024-01-15T10:30:00Z"

updatedAt

string

required

ISO 8601 timestamp of last update

Example:

"2024-01-15T10:35:00Z"

List users Get user

⌘I