v2

latestOpenAPI 3.1.02026-07-267085761.0 MB

Platform Address

Create Payee Mailing Address

Creates a new address for an existing payee contact.

This endpoint will:

Verify the payee exists and belongs to the specified user
Validate the address information and format
Check that the payee hasn't exceeded the maximum of 5 addresses
Create and store the new address for future check payments

Each payee can have up to 20 different addresses to support multiple locations or address changes. These addresses can be used when sending physical check payments.

post/api/platform/address/create-payee-address/{user_id}

Path parameters

user_idstring uuid required

Unique identifier (UUID) of the user

Headers

X-Platform-IDstring uuid required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signaturestring required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Request body

payee_idstring uuid4 required

Unique identifier (UUID) of the payee for whom this address is being created.

namestring required

Recipient's first name.

last_namestring nullable

Recipient's last name (optional).

address_line_1string required

Street address including apartment, suite, or unit number.

address_line_2string nullable

Street address including apartment, suite, or unit number.

company_namestring nullable

Full name of the payee's company.

citystring required

City name.

statestring required

State, province, or region.

zipcodestring required

Postal code or ZIP code.

countrystring required

Country name.

Example request

{
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "name": "John",
  "last_name": "Smith",
  "address_line_1": "123 Main Street, Apt 4B",
  "address_line_2": "123 Main Street, Apt 4B",
  "company_name": "Meta Corp",
  "city": "New York",
  "state": "NY",
  "zipcode": "10001",
  "country": "United States"
}

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

A short, human-readable message describing the result of the request.

queryGeneratedTimenumber nullable

The Unix timestamp (in seconds) indicating when the response was generated.

Example response

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
    "fist_name": "John",
    "last_name": "Doe",
    "address_line_1": "123 Main Street, Apt 4B",
    "address_line_2": "123 Main Street, Apt 4B",
    "company_name": "Meta Corp",
    "city": "New York",
    "state": "NY",
    "zipcode": "10001",
    "country": "United States",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  "queryGeneratedTime": 1718006400
}