Register a User

Read on how to create SEND users in our system

This endpoint creates a new user account for both individual and business users with just the user's basic information. If you want to enable sending capabilities to a user, you need to specify it with "type": "SEND" in the request. Only users in originating corridors enabled for you can be created with send capabilities.

A unique ID will be generated as a response. Please note the additional parameters for the Business user compared to an individual user. More details on the request sample.

POST /users

Request Sample

Individual User

curl --location -g --request POST '{{url}}/users' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "Tenzin",
    "last_name": "Norgay",
    "email": "[e-mail]",
    "gender": "female",
    "date_of_birth": "2000-01-01",
    "address_line1": "500 8 El Camino Real Santa Clara",
    "mobile_phone": "9879879870",
    "city": "Santa Clara",
    "zipcode": "95053",
    "state": "CA",
    "country": "US",
    "ip_address": "73.85.79.9",
    "type": "SEND",
    "physical_documents": [
         {
            "document_value": "data:image/jpg;base64,SUQsasasasas909090==",
            "document_type": "STATE_ID",
            "country": "US",
            "expiry_date": "2025-03-09",
            "state": "CA"
        }
        ],
    "virtual_documents": [
        {
            "document_value": "111111111",
            "document_type": "PASSPORT",
            "expiry_date": "2025-03-09",
            "id_issuing_authority": "CA",
            "country": "US",
            "state": "CA"
        },
        {
            "document_value": "111111111",
            "document_type": "SSN",
            "expiry_date": "2025-03-09",
            "id_issuing_authority": "CA",
            "country": "US",
            "state": "CA"
        }
    ]
  }'

Business user

curl --location -g --request POST '{{url}}/users' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "Machnet Technologies Inc",
    "mobile_phone": "2222222222",
    "address_line1": "500 8 El Camino Real Santa Clara",
    "city": "Santa Clara",
    "zipcode": "95053",
    "state": "CA",
    "country": "US",
    "email": "[e-mail]",
    "ip_address": "10.0.10.5",
    "date_of_birth": "1995-01-01",
    "business": true,
    "business_type": "LLC",
    "user_scope": "COMPUTER_TECHNOLOGY",
    "company_website": "www.example.com",
    "number_of_employee": "BETWEEN_25_TO_50",
    "type": "SEND",
    "mailing_address": {
        "country": "US",
        "city": "Santa Clara",
        "address_line1": "500 8 El Camino Real Santa Clara",
        "zipcode": "95053",
        "state": "CA",
        "address_line2": null
    },
    "physical_documents": [
        {
            "document_value": "data:application/pdf;base64,SUQs==",
            "document_type": "EIN"
            "expiry_date": "2025-03-09",
            "state": "CA"
        }
    ],
    "virtual_documents": [
        {
            "document_value": "823452222",
            "document_type": "EIN_NUMBER"
            "expiry_date": "2025-03-09",
            "id_issuing_authority": "CA",
            "state": "CA",
        }
    ]
}'

Response Sample

{
    "address_line1": "500 8 El Camino Real Santa Clara",
    "city": "Santa Clara",
    "country": "US",
    "created_at": "2022-03-11T04:32:24.48354",
    "date_of_birth": "2000-01-01",
    "email": "[e-mail]",
    "first_name": "Tenzin",
    "gender": "female",
    "id": "022ea509-a4ab-4bb9-ad98-305c08bd2b42",
    "ip_address": "73.85.79.9",
    "last_name": "Norgay",
    "mobile_phone": "9879879870",
    "state": "CA",
    "status": "UNVERIFIED",
    "zipcode": "95053",
    "business": false,
    "type": "SEND",
    "physical_documents": [
         {
            "id": {{UUID}},
            "document_type": "STATE_ID",
            "country": "US",
            "expiry_date": "2025-03-09",
            "state": "CA"
        }
        ],
    "virtual_documents": [
        {
            "document_value": "111111111",
            "id": {{UUID}},
            "document_type": "PASSPORT",
            "expiry_date": "2025-03-09",
            "id_issuing_authority": "CA",
            "country": "US",
            "state": "CA"
        },
        {
            "document_value": "111111111",
            "id": {{UUID}},
            "document_type": "SSN",
            "expiry_date": "2025-03-09",
            "id_issuing_authority": "CA",
            "country": "US",
            "state": "CA"
        }
    ]
}

Business User

{
    "address_line1": "500 8 El Camino Real Santa Clara",
    "city": "Santa Clara",
    "company_website": "www.example.com",
    "country": "US",
    "created_at": "2022-04-22T02:21:23.084565",
    "date_of_birth": "1995-01-01",
    "email": "[e-mail]",
    "first_name": "Machnet Technologies Inc",
    "id": {{UUID}},
    "ip_address": "10.0.10.5",
    "mailing_address": {
        "address_line1": "500 8 El Camino Real Santa Clara",
        "city": "Santa Clara",
        "country": "US",
        "state": "CA",
        "zipcode": "95053"
    },
    "mobile_phone": "2222222222",
    "number_of_employee": "BETWEEN_25_TO_50",
    "physical_documents": [
        {
            "document_type": "EIN",
            "id": {{UUID}},
            "expiry_date": "2025-03-09",
            "state": "CA"
        }
    ],
    "state": "CA",
    "status": "UNVERIFIED",
    "user_scope": "COMPUTER_TECHNOLOGY",
    "virtual_documents": [
        {
            "document_type": "EIN_NUMBER",
            "document_value": "2222",
            "id": {{UUID}},
            "expiry_date": "2025-03-09",
            "id_issuing_authority": "CA",
            "state": "CA",
        }
    ],
    "zipcode": "95053",
    "business": true,
    "business_type": "LLC",
    "type": "SEND"
}