Skip to main content
POST
/
v2
/
users
Create a user
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "user_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWQiOiIxNDRhMTRkNS04YzEzLTQzZGYtOTI4Ni01OWY4NjFkOWEyMDIiLCJleHAiOjE2NzgzNDExNDMsImZpZCI6ImIyYzY4YzUwLTc2MTQtNDAwNy1iMzNmLWZiMzlkMDFmMmM3MCIsImlhdCI6MTY3ODMzNzU0MywiaXNzIjoiYXJneWxlLWNvcmUtYXV0aC1kZXYiLCJqdGkiOiI3ZTU0ZTY1NS05YWN2LTRiZDctOWI3OC0xODMxMjVkYjM1MzMiLCJzdWIiOiIwMTg2YzRiNi04ZTgyLWQ5OWMtOGY4Mi1mNjMyMjgxMzk2ZTQiLCJ1c2VyX2lkIjoiMDE4NmM0YjYtOGU4Mi1kOTljLThmODItZjYzMjI4MTM5NmU0In0.q5bkZTFAohISOcjJDb2wSzKcHmwrOM4pp9imOVybaWk",
  "id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69"
}

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
first_name
string

Pre-fill Link's login screen with this first name.

​
last_name
string

Pre-fill Link's login screen with this last name.

​
email
string

Pre-fill Link's login screen with this email.

Invalid email addresses will cause the request to fail. We recommend client-side validation and retrying the request without the invalid email if you receive:

{
  "email": [
    "Enter a valid email address."
  ]
}
​
phone_number
string

Pre-fill Link's login screen with this phone number. E.164 international format recommended.

Invalid phone numbers will cause the request to fail. We recommend client-side validation and retrying the request without the invalid phone number if you receive:

{
  "phone_number": [
    "Enter a valid phone number."
  ]
}
​
ssn
string

Social Security number.

Required for banking reports.

​
address
object

Address of the user.

Required for banking reports.

​
birth_date
object

Date of birth of the user.

Required for banking reports.

​
external_metadata
object

Any valid JSON.

Must be an object {} when used for banking reports.

​
open_banking
object

Used for banking reports.

​
external_id
string

Any string. Maximum 100 characters.

Response

200 - application/json
​
user_token
string

Token associated with the created user.

​
id
string<uuid>

Unique ID of the user.