Skip to main content
POST
Create a user
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.

Provided to you by your Argyle Customer Success manager.
first_name
string

User first name.

last_name
string

User last name.

email
string

User email address.

Required for banking verifications when phone_number is not provided.

phone_number
string

User phone number. E.164 international format recommended.

Required for banking verifications when email is not provided.

ssn
string

User Social Security number.

Required for banking verifications when birth_date is not provided.

address
object

Address of the user.

birth_date
object

User date of birth.

Required for banking verifications when ssn is not provided.

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.