Create an individual user entity within your program.
curl --request POST \
--url https://api.example.com/api/v3/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"
}
}
}Documentation Index
Fetch the complete documentation index at: https://developers.ingopayments.com/llms.txt
Use this file to discover all available pages before exploring further.
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.
First name.
Last name.
Street address line 1.
City.
5-digit US ZIP code.
ISO 3166-1 alpha-2 country code.
ISO 3166-2 two-letter state/region code.
Email address.
"jane.doe@example.com"
Phone number in E.164 format.
"+12125551234"
Program API key. Accepted either in the api_key HTTP header or as this body field.
Social security number. Encrypted at rest.
Date of birth in YYYY-MM-DD format.
"1990-04-15"
Middle name.
Street address line 2.
Chosen username for the user.
True to confirm the end user accepted the program terms.
Optional. When supplied, the created user is also linked as a contact of this business.
"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"
Optional. When business_id is supplied, marks the created business contact as a vendor.
Success.
success "operation completed"
Endpoint-specific payload; shape varies per operation.
Hide child attributes
Hide child attributes
User entity id; prefix user-.
"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"
"Jane"
"Doe"
"jane.doe@example.com"
"+12125551234"
"1990-04-15"
"6789"
"active"
"verified"
"2026-04-16T12:34:56.000Z"
"2026-04-16T12:34:56.000Z"
curl --request POST \
--url https://api.example.com/api/v3/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"
}
}
}