Create User - Payward Developer Documentation

curl

curl -X POST "https://api.services.payward.com/v1/users" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "external_reference": "partner-customer-9001",
    "full_name": {"first_name": "Alex", "last_name": "Morgan"},
    "birth": {"date": "1990-04-15", "city": "San Francisco", "country": "US"},
    "residence": {"line1": "1 Market St", "city": "San Francisco", "postal_code": "94103", "country": "US"},
    "phone": "+14155550110",
    "nationalities": ["US"],
    "occupation": "computers_and_it"
  }'

import requests

url = "https://api.services.payward.com/v1/users"

payload = {
    "email": "[email protected]",
    "external_reference": "partner-customer-9001",
    "full_name": {
        "first_name": "Alex",
        "last_name": "Morgan"
    },
    "birth": {
        "date": "1990-04-15",
        "city": "San Francisco",
        "country": "US"
    },
    "residence": {
        "line1": "1 Market St",
        "city": "San Francisco",
        "postal_code": "94103",
        "country": "US"
    },
    "phone": "+14155550110",
    "nationalities": ["US"],
    "occupation": "computers_and_it"
}
headers = {
    "API-Key": "<api-key>",
    "API-Nonce": "<api-key>",
    "API-Sign": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'API-Key': '<api-key>',
    'API-Nonce': '<api-key>',
    'API-Sign': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: '[email protected]',
    external_reference: 'partner-customer-9001',
    full_name: {first_name: 'Alex', last_name: 'Morgan'},
    birth: {date: '1990-04-15', city: 'San Francisco', country: 'US'},
    residence: {
      line1: '1 Market St',
      city: 'San Francisco',
      postal_code: '94103',
      country: 'US'
    },
    phone: '+14155550110',
    nationalities: ['US'],
    occupation: 'computers_and_it'
  })
};

fetch('https://api.services.payward.com/v1/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.services.payward.com/v1/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([
    'email' => '[email protected]',
    'external_reference' => 'partner-customer-9001',
    'full_name' => [
        'first_name' => 'Alex',
        'last_name' => 'Morgan'
    ],
    'birth' => [
        'date' => '1990-04-15',
        'city' => 'San Francisco',
        'country' => 'US'
    ],
    'residence' => [
        'line1' => '1 Market St',
        'city' => 'San Francisco',
        'postal_code' => '94103',
        'country' => 'US'
    ],
    'phone' => '+14155550110',
    'nationalities' => [
        'US'
    ],
    'occupation' => 'computers_and_it'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>",
    "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.services.payward.com/v1/users"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"external_reference\": \"partner-customer-9001\",\n  \"full_name\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Morgan\"\n  },\n  \"birth\": {\n    \"date\": \"1990-04-15\",\n    \"city\": \"San Francisco\",\n    \"country\": \"US\"\n  },\n  \"residence\": {\n    \"line1\": \"1 Market St\",\n    \"city\": \"San Francisco\",\n    \"postal_code\": \"94103\",\n    \"country\": \"US\"\n  },\n  \"phone\": \"+14155550110\",\n  \"nationalities\": [\n    \"US\"\n  ],\n  \"occupation\": \"computers_and_it\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	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.services.payward.com/v1/users")
  .header("API-Key", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .header("API-Sign", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"external_reference\": \"partner-customer-9001\",\n  \"full_name\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Morgan\"\n  },\n  \"birth\": {\n    \"date\": \"1990-04-15\",\n    \"city\": \"San Francisco\",\n    \"country\": \"US\"\n  },\n  \"residence\": {\n    \"line1\": \"1 Market St\",\n    \"city\": \"San Francisco\",\n    \"postal_code\": \"94103\",\n    \"country\": \"US\"\n  },\n  \"phone\": \"+14155550110\",\n  \"nationalities\": [\n    \"US\"\n  ],\n  \"occupation\": \"computers_and_it\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["API-Nonce"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[email protected]\",\n  \"external_reference\": \"partner-customer-9001\",\n  \"full_name\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Morgan\"\n  },\n  \"birth\": {\n    \"date\": \"1990-04-15\",\n    \"city\": \"San Francisco\",\n    \"country\": \"US\"\n  },\n  \"residence\": {\n    \"line1\": \"1 Market St\",\n    \"city\": \"San Francisco\",\n    \"postal_code\": \"94103\",\n    \"country\": \"US\"\n  },\n  \"phone\": \"+14155550110\",\n  \"nationalities\": [\n    \"US\"\n  ],\n  \"occupation\": \"computers_and_it\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "AA45N8G4MLDYWAR7",
    "accounts": [
      {
        "id": "WX6VJUKWKKPBQE36",
        "name": "main"
      },
      {
        "id": "WC9RDEFHPSGLXRVX",
        "name": "secondary"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 400,
    "instance": "<string>",
    "code": "bad_request",
    "doc_url": "<string>",
    "causes": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 401,
    "instance": "<string>",
    "code": "unauthenticated",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 403,
    "instance": "<string>",
    "code": "forbidden",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 429,
    "instance": "<string>",
    "code": "resource_exhausted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 500,
    "instance": "<string>",
    "code": "internal",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 501,
    "instance": "<string>",
    "code": "unimplemented",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 503,
    "instance": "<string>",
    "code": "unavailable",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 504,
    "instance": "<string>",
    "code": "deadline_exceeded",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

POST

users

curl

curl -X POST "https://api.services.payward.com/v1/users" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "external_reference": "partner-customer-9001",
    "full_name": {"first_name": "Alex", "last_name": "Morgan"},
    "birth": {"date": "1990-04-15", "city": "San Francisco", "country": "US"},
    "residence": {"line1": "1 Market St", "city": "San Francisco", "postal_code": "94103", "country": "US"},
    "phone": "+14155550110",
    "nationalities": ["US"],
    "occupation": "computers_and_it"
  }'

import requests

url = "https://api.services.payward.com/v1/users"

payload = {
    "email": "[email protected]",
    "external_reference": "partner-customer-9001",
    "full_name": {
        "first_name": "Alex",
        "last_name": "Morgan"
    },
    "birth": {
        "date": "1990-04-15",
        "city": "San Francisco",
        "country": "US"
    },
    "residence": {
        "line1": "1 Market St",
        "city": "San Francisco",
        "postal_code": "94103",
        "country": "US"
    },
    "phone": "+14155550110",
    "nationalities": ["US"],
    "occupation": "computers_and_it"
}
headers = {
    "API-Key": "<api-key>",
    "API-Nonce": "<api-key>",
    "API-Sign": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'API-Key': '<api-key>',
    'API-Nonce': '<api-key>',
    'API-Sign': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: '[email protected]',
    external_reference: 'partner-customer-9001',
    full_name: {first_name: 'Alex', last_name: 'Morgan'},
    birth: {date: '1990-04-15', city: 'San Francisco', country: 'US'},
    residence: {
      line1: '1 Market St',
      city: 'San Francisco',
      postal_code: '94103',
      country: 'US'
    },
    phone: '+14155550110',
    nationalities: ['US'],
    occupation: 'computers_and_it'
  })
};

fetch('https://api.services.payward.com/v1/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.services.payward.com/v1/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([
    'email' => '[email protected]',
    'external_reference' => 'partner-customer-9001',
    'full_name' => [
        'first_name' => 'Alex',
        'last_name' => 'Morgan'
    ],
    'birth' => [
        'date' => '1990-04-15',
        'city' => 'San Francisco',
        'country' => 'US'
    ],
    'residence' => [
        'line1' => '1 Market St',
        'city' => 'San Francisco',
        'postal_code' => '94103',
        'country' => 'US'
    ],
    'phone' => '+14155550110',
    'nationalities' => [
        'US'
    ],
    'occupation' => 'computers_and_it'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>",
    "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.services.payward.com/v1/users"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"external_reference\": \"partner-customer-9001\",\n  \"full_name\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Morgan\"\n  },\n  \"birth\": {\n    \"date\": \"1990-04-15\",\n    \"city\": \"San Francisco\",\n    \"country\": \"US\"\n  },\n  \"residence\": {\n    \"line1\": \"1 Market St\",\n    \"city\": \"San Francisco\",\n    \"postal_code\": \"94103\",\n    \"country\": \"US\"\n  },\n  \"phone\": \"+14155550110\",\n  \"nationalities\": [\n    \"US\"\n  ],\n  \"occupation\": \"computers_and_it\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	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.services.payward.com/v1/users")
  .header("API-Key", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .header("API-Sign", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"external_reference\": \"partner-customer-9001\",\n  \"full_name\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Morgan\"\n  },\n  \"birth\": {\n    \"date\": \"1990-04-15\",\n    \"city\": \"San Francisco\",\n    \"country\": \"US\"\n  },\n  \"residence\": {\n    \"line1\": \"1 Market St\",\n    \"city\": \"San Francisco\",\n    \"postal_code\": \"94103\",\n    \"country\": \"US\"\n  },\n  \"phone\": \"+14155550110\",\n  \"nationalities\": [\n    \"US\"\n  ],\n  \"occupation\": \"computers_and_it\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["API-Nonce"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[email protected]\",\n  \"external_reference\": \"partner-customer-9001\",\n  \"full_name\": {\n    \"first_name\": \"Alex\",\n    \"last_name\": \"Morgan\"\n  },\n  \"birth\": {\n    \"date\": \"1990-04-15\",\n    \"city\": \"San Francisco\",\n    \"country\": \"US\"\n  },\n  \"residence\": {\n    \"line1\": \"1 Market St\",\n    \"city\": \"San Francisco\",\n    \"postal_code\": \"94103\",\n    \"country\": \"US\"\n  },\n  \"phone\": \"+14155550110\",\n  \"nationalities\": [\n    \"US\"\n  ],\n  \"occupation\": \"computers_and_it\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "AA45N8G4MLDYWAR7",
    "accounts": [
      {
        "id": "WX6VJUKWKKPBQE36",
        "name": "main"
      },
      {
        "id": "WC9RDEFHPSGLXRVX",
        "name": "secondary"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 400,
    "instance": "<string>",
    "code": "bad_request",
    "doc_url": "<string>",
    "causes": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 401,
    "instance": "<string>",
    "code": "unauthenticated",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 403,
    "instance": "<string>",
    "code": "forbidden",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 429,
    "instance": "<string>",
    "code": "resource_exhausted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 500,
    "instance": "<string>",
    "code": "internal",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 501,
    "instance": "<string>",
    "code": "unimplemented",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 503,
    "instance": "<string>",
    "code": "unavailable",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 504,
    "instance": "<string>",
    "code": "deadline_exceeded",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

Authorizations

API-Key

string

header

required

Your public API key. Identifies the partner making the request.

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

API-Sign

string

header

required

HMAC signature over the request, computed with your private key.

Body

application/json

Request to create a new user.

string<email>

required

The email associated with the user.

Maximum string length: 254

external_reference

string

required

Stable partner-supplied reference for this user. Must be unique within your partner account. Reuse the same value only for the same user, including create retries.

Required string length: 1 - 256

full_name

object

required

User's full name

Show child attributes

birth

object

required

User's place and date of birth.

Show child attributes

residence

object

required

User's residential address

Show child attributes

phone

string

required

Phone number in E.164 format

Required string length: 1 - 16

Pattern: ^\+?[1-9]\d{1,14}$

nationalities

enum<string>[]

required

User's nationalities

ISO 3166-1 alpha-2 country code.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW,

AC,

AN,

AP,

CP,

DG,

EA,

EU,

IC,

JX,

TA,

QO,

XK,

0C

Required string length: 2

occupation

enum<string>

required

User's occupation

Available options:

agriculture,

business_management,

computers_and_it,

construction,

education,

finance,

government,

healthcare,

hospitality,

manufacturing,

marketing,

media,

other,

science,

self_employed,

student,

transportation,

unemployed,

employed

employer_name

string | null

Name of user's employer

Required string length: 1 - 256

tax_ids

object[] | null

User's tax ID

Show child attributes

client_identifier

object

Identifier assigned by the partner platform

Show child attributes

language

string | null

The user's preferred language, as an ISO 639-1 language code. If not provided, the user's language will be set to the default language for their country.

Pattern: ^[a-z]{2}$

Response

Created

data

object

required

Created user payload.

Show child attributes

Update User Create Headless User

⌘I