Skip to main content
POST
/
partners
/
v2
/
users
Create a user
curl --request POST \
  --url https://api-sandbox.argyle.com/partners/v2/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7",
  "first_name": "Jane",
  "last_name": "Doe",
  "ssn": "000-00-0000",
  "email": "[email protected]",
  "phone_number": "+15555555555",
  "address": {
    "city": "New York",
    "line1": "123 Main St",
    "line2": null,
    "state": "NY",
    "country": "US",
    "postal_code": null
  },
  "birth_date": {
    "year": 1990,
    "month": 1,
    "day": 13
  },
  "external_id": null,
  "external_metadata": {
    "suppress_verification": true
  }
}
'
{
  "user_token": "<SECRET>",
  "id": "7a614711-066f-4b6b-b319-4c6236b5acc1"
}
Set external_metadata.suppress_verification to true for banking and document verification workflows.

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
client
string<uuid>
required

ID of the client on whose behalf the user is created.

first_name
string

User first name.

last_name
string

User last name.

email
string

User email address.

phone_number
string

User phone number. E.164 international format recommended.

ssn
string

User Social Security number.

address
object

Address of the user.

birth_date
object

Date of birth in year-month-day format.

external_metadata
object

Additional metadata for internal partner workflows.

open_banking
object

Banking-specific user metadata.

external_id
string | null

External identifier for your internal mapping.

Response

200 - application/json

Response returned after creating a partner user.

user_token
string

Token associated with the created user.

id
string<uuid>

Unique ID of the user.