Skip to main content
POST
/
api
/
platform
/
check
/
add-address
/
{user_id}
Create a check mailing address for a user
curl --request POST \
  --url https://api.sandbox.paywint.com/api/platform/check/add-address/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "address_line_1": "Building B, Floor 3",
  "city": "San Francisco",
  "state": "CA",
  "zipcode": "94103",
  "country": "United States",
  "name": "John Doe",
  "address_line_2": "123 Market St, Suite 500"
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "address_line_1": "Building B, Floor 3",
    "city": "San Francisco",
    "state": "CA",
    "zipcode": "94103",
    "country": "United States",
    "address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
    "created_at": "2024-01-15T10:30:00Z",
    "name": "John Smith",
    "address_line_2": "123 Market St, Suite 500",
    "updated_at": "2024-02-10T14:05:22Z"
  },
  "queryGeneratedTime": 1718006400
}

Headers

​
X-Platform-ID
string<uuid>
required

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

​
X-Signature
string
required

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

Path Parameters

​
user_id
string<uuid>
required

Unique identifier (UUID) of the user whose check address is being created.

Body

application/json
​
address_line_1
string
required

Secondary address line (optional).

Maximum string length: 64
Example:

"Building B, Floor 3"

​
city
string
required

City name.

Maximum string length: 40
Example:

"San Francisco"

​
state
string
required

State, province, or region.

Maximum string length: 30
Example:

"CA"

​
zipcode
string
required

Postal or ZIP code.

Required string length: 5 - 10
Example:

"94103"

​
country
string
required

Country name.

Maximum string length: 40
Example:

"United States"

​
name
string | null

Display name shown on checks (e.g., company or account label).

Required string length: 2 - 180
Example:

"John Doe"

​
address_line_2
string | null

Primary street address, including suite/apartment if applicable.

Maximum string length: 64
Example:

"123 Market St, Suite 500"

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
message
string
default:Success

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

Example:

"Operation completed."

​
data
ExternalCheckAddressRead · object

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1765631850.663502

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

Example:

1718006400