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": "jane@example.com",
"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
}
}
'import requests
url = "https://api-sandbox.argyle.com/partners/v2/users"
payload = {
"client": "39096494-45c8-4fd8-9454-3d1cb2d62db7",
"first_name": "Jane",
"last_name": "Doe",
"ssn": "000-00-0000",
"email": "jane@example.com",
"phone_number": "+15555555555",
"address": {
"city": "New York",
"line1": "123 Main St",
"line2": None,
"state": "NY",
"country": "US",
"postal_code": None
},
"birth_date": {
"year": 1990,
"month": 1,
"day": 13
},
"external_id": None,
"external_metadata": { "suppress_verification": True }
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client: '39096494-45c8-4fd8-9454-3d1cb2d62db7',
first_name: 'Jane',
last_name: 'Doe',
ssn: '000-00-0000',
email: 'jane@example.com',
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}
})
};
fetch('https://api-sandbox.argyle.com/partners/v2/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/partners/v2/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client' => '39096494-45c8-4fd8-9454-3d1cb2d62db7',
'first_name' => 'Jane',
'last_name' => 'Doe',
'ssn' => '000-00-0000',
'email' => 'jane@example.com',
'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
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/partners/v2/users"
payload := strings.NewReader("{\n \"client\": \"39096494-45c8-4fd8-9454-3d1cb2d62db7\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"ssn\": \"000-00-0000\",\n \"email\": \"jane@example.com\",\n \"phone_number\": \"+15555555555\",\n \"address\": {\n \"city\": \"New York\",\n \"line1\": \"123 Main St\",\n \"line2\": null,\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postal_code\": null\n },\n \"birth_date\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 13\n },\n \"external_id\": null,\n \"external_metadata\": {\n \"suppress_verification\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.argyle.com/partners/v2/users")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"client\": \"39096494-45c8-4fd8-9454-3d1cb2d62db7\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"ssn\": \"000-00-0000\",\n \"email\": \"jane@example.com\",\n \"phone_number\": \"+15555555555\",\n \"address\": {\n \"city\": \"New York\",\n \"line1\": \"123 Main St\",\n \"line2\": null,\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postal_code\": null\n },\n \"birth_date\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 13\n },\n \"external_id\": null,\n \"external_metadata\": {\n \"suppress_verification\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/partners/v2/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client\": \"39096494-45c8-4fd8-9454-3d1cb2d62db7\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"ssn\": \"000-00-0000\",\n \"email\": \"jane@example.com\",\n \"phone_number\": \"+15555555555\",\n \"address\": {\n \"city\": \"New York\",\n \"line1\": \"123 Main St\",\n \"line2\": null,\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postal_code\": null\n },\n \"birth_date\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 13\n },\n \"external_id\": null,\n \"external_metadata\": {\n \"suppress_verification\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"user_token": "<SECRET>",
"id": "7a614711-066f-4b6b-b319-4c6236b5acc1"
}Create a user
Creates a new user object for partner verification workflows.
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": "jane@example.com",
"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
}
}
'import requests
url = "https://api-sandbox.argyle.com/partners/v2/users"
payload = {
"client": "39096494-45c8-4fd8-9454-3d1cb2d62db7",
"first_name": "Jane",
"last_name": "Doe",
"ssn": "000-00-0000",
"email": "jane@example.com",
"phone_number": "+15555555555",
"address": {
"city": "New York",
"line1": "123 Main St",
"line2": None,
"state": "NY",
"country": "US",
"postal_code": None
},
"birth_date": {
"year": 1990,
"month": 1,
"day": 13
},
"external_id": None,
"external_metadata": { "suppress_verification": True }
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client: '39096494-45c8-4fd8-9454-3d1cb2d62db7',
first_name: 'Jane',
last_name: 'Doe',
ssn: '000-00-0000',
email: 'jane@example.com',
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}
})
};
fetch('https://api-sandbox.argyle.com/partners/v2/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/partners/v2/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'client' => '39096494-45c8-4fd8-9454-3d1cb2d62db7',
'first_name' => 'Jane',
'last_name' => 'Doe',
'ssn' => '000-00-0000',
'email' => 'jane@example.com',
'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
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/partners/v2/users"
payload := strings.NewReader("{\n \"client\": \"39096494-45c8-4fd8-9454-3d1cb2d62db7\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"ssn\": \"000-00-0000\",\n \"email\": \"jane@example.com\",\n \"phone_number\": \"+15555555555\",\n \"address\": {\n \"city\": \"New York\",\n \"line1\": \"123 Main St\",\n \"line2\": null,\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postal_code\": null\n },\n \"birth_date\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 13\n },\n \"external_id\": null,\n \"external_metadata\": {\n \"suppress_verification\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.argyle.com/partners/v2/users")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"client\": \"39096494-45c8-4fd8-9454-3d1cb2d62db7\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"ssn\": \"000-00-0000\",\n \"email\": \"jane@example.com\",\n \"phone_number\": \"+15555555555\",\n \"address\": {\n \"city\": \"New York\",\n \"line1\": \"123 Main St\",\n \"line2\": null,\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postal_code\": null\n },\n \"birth_date\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 13\n },\n \"external_id\": null,\n \"external_metadata\": {\n \"suppress_verification\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/partners/v2/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client\": \"39096494-45c8-4fd8-9454-3d1cb2d62db7\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"ssn\": \"000-00-0000\",\n \"email\": \"jane@example.com\",\n \"phone_number\": \"+15555555555\",\n \"address\": {\n \"city\": \"New York\",\n \"line1\": \"123 Main St\",\n \"line2\": null,\n \"state\": \"NY\",\n \"country\": \"US\",\n \"postal_code\": null\n },\n \"birth_date\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 13\n },\n \"external_id\": null,\n \"external_metadata\": {\n \"suppress_verification\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"user_token": "<SECRET>",
"id": "7a614711-066f-4b6b-b319-4c6236b5acc1"
}external_metadata.suppress_verification to true for banking and document verification workflows.Authorizations
Username = api_key_id, Password = api_key_secret
Body
ID of the client on whose behalf the user is created.
Provided to you by your Argyle Customer Success manager.User first name.
User last name.
User email address.
Required for banking verifications when phone_number is not provided.
User phone number. E.164 international format recommended.
Required for banking verifications when email is not provided.
User Social Security number.
Required for banking verifications when birth_date is not provided.
Address of the user.
Show child attributes
Show child attributes
User date of birth.
Required for banking verifications when ssn is not provided.
Show child attributes
Show child attributes
Additional metadata for internal partner workflows.
Show child attributes
Show child attributes
Banking-specific user metadata.
Show child attributes
Show child attributes
External identifier for your internal mapping.