Skip to main content
POST
/
v2
/
payer
curl --request POST \
  --url https://api.request.network/v2/payer \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "clientUserId": "user-123",
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "beneficiaryType": "individual",
  "dateOfBirth": "1985-12-12",
  "addressLine1": "123 Main Street",
  "city": "New York",
  "state": "NY",
  "postcode": "10001",
  "country": "US",
  "nationality": "US",
  "phone": "+12125551234",
  "ssn": "123-45-6789"
}
'
{
  "agreementUrl": "https://core-api.pay.so/v1/public/agreements?email=john.doe%40example.com",
  "kycUrl": "https://sumsub.com/idensic/l/#/sbx_VvK9E9P2A23xQPoA",
  "status": {
    "agreementStatus": "not_started",
    "kycStatus": "not_started"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.request.network/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
string
required

API key for authentication

Body

application/json
​
clientUserId
string
required

Client User ID

Minimum string length: 1
​
email
string<email>
required

Email

​
firstName
string
required

First Name

Minimum string length: 1
​
lastName
string
required

Last Name

Minimum string length: 1
​
beneficiaryType
enum<string>
required
Available options:
individual,
business
​
dateOfBirth
string
required

Date of birth in YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
​
addressLine1
string
required

Address Line 1

Minimum string length: 1
​
city
string
required

City

Minimum string length: 1
​
state
string
required

State

Minimum string length: 1
​
postcode
string
required

Postcode

Minimum string length: 1
​
country
string
required

Country

Required string length: 2
​
nationality
string
required

Nationality

Required string length: 2
​
phone
string
required

Phone in E.164 format

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

Social Security Number

Minimum string length: 1
​
companyName
string

Company Name

​
addressLine2
string

Address Line 2

​
sourceOfFunds
string

Source of Funds

​
businessActivity
string

Business Activity

Response

Compliance data retrieved successfully

​
status
object
required
​
agreementUrl
string<uri>
​
kycUrl
string<uri>
​
userId
string<uuid>