Skip to main content
POST
/
user
/
create
Create a user entity
curl --request POST \
  --url https://api.sdev.banking.ingopayments.tech/api/v4/user/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "api_key": "YOUR_API_KEY",
  "email": "jane.doe@example.com",
  "first_name": "Alex",
  "middle_name": "",
  "last_name": "Rivera",
  "phone_number": "+15555551234",
  "postal_code": "30044",
  "country": "US",
  "state": "TX",
  "city": "Anytown",
  "address_one": "100 Innovation Way",
  "address_two": "Suite 100",
  "username": "janedoe",
  "date_of_birth": "1980-04-20",
  "ssn": "XXXXXXXXX",
  "terms_accepted": true,
  "meta_data": [
    {
      "name": "external_ref",
      "value": "customer-001"
    }
  ]
}
'
{
  "status": "success",
  "message": "operation completed",
  "data": {
    "items": [
      {
        "id": "user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef",
        "uuid": "<string>",
        "first_name": "Jane",
        "middle_name": "<string>",
        "last_name": "Doe",
        "email": "jane.doe@example.com",
        "phone_number": "+12125551234",
        "date_of_birth": "1990-04-15",
        "address_one": "<string>",
        "address_two": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "postal_code": "<string>",
        "ssn_last_4": "6789",
        "status": "active",
        "kyc_status": "verified",
        "created_at": "2026-04-16T12:34:56.000Z",
        "updated_at": "2026-04-16T12:34:56.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total": 100,
      "sort": "created_at:desc",
      "search": "jane"
    }
  }
}

Authorizations

​
api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
​
first_name
string
required

First name.

​
last_name
string
required

Last name.

​
address_one
string
required

Street address line 1.

​
city
string
required

City.

​
postal_code
string
required

5-digit US ZIP code.

​
country
string
required

ISO 3166-1 alpha-2 country code.

​
state
string
required

ISO 3166-2 two-letter state/region code.

​
email
string<email>
required

Email address.

Example:

"jane.doe@example.com"

​
phone_number
string
required

Phone number in E.164 format.

Example:

"+12125551234"

​
api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

​
ssn
string

Social security number. Encrypted at rest.

​
date_of_birth
string<date>

Date of birth in YYYY-MM-DD format.

Example:

"1990-04-15"

​
middle_name
string

Middle name.

​
address_two
string

Street address line 2.

​
username
string

Chosen username for the user.

​
terms_accepted
boolean

True to confirm the end user accepted the program terms.

​
meta_data
object[]

List of {name, value} pairs to persist alongside the entity.

​
business_id
string

Optional. When supplied, the created user is also linked as a contact of this business.

Example:

"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"

​
is_vendor
boolean

Optional. When business_id is supplied, marks the created business contact as a vendor.

Response

Success.

​
status
enum<string>
required
Available options:
success
​
message
string
required
Example:

"operation completed"

​
data
object

Endpoint-specific payload; shape varies per operation.