Create an address
URL
POST https://api.complycube.com/v1/addresses
Creates a new address.
Headers
Content-Type
*
string
The content-type must always be set to application/json
.
Authorization
*
string
The API live
or test
key.
Body
clientId
*
string
The ID of the client associated with this address.
type
string
The type of address. Valid values include:
1. main
2. alternative
3. other
propertyNumber
string
The property number of the client's address.
buildingName
string
The building name of the client's address.
line
*
string
The line of the client's address.
city
*
string
The city or town of the client's address.
state
string
The county, state, or province of the client's address. When country is US
, this must be the state's USPS abbreviation (e.g. NY
, CA
, or DE
).
postalCode
string
The zip or postcode of the client's address.
fromDate
string
The date the client moved into this address. The format is YYYY-MM-DD
.
toDate
string
The date the client moved out of this address. The format is YYYY-MM-DD
.
Example request
curl -X POST https://api.complycube.com/v1/clients \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"CLIENT_ID",
"type": "main",
"propertyNumber": "Flat 323",
"line": "Common street",
"city": "Aldgate",
"state": "London",
"postalCode": "W99 0RD",
"country": "GB",
"fromDate": "2007-09-01"
}'
Example responses
{
"id": "5eb1276f96be4a0008713af6",
"clientId": "5eb1276d96be4a0008713af5",
"type": "main",
"propertyNumber": "Flat 323",
"line": "Common street",
"city": "Aldgate",
"state": "London",
"postalCode": "W10 11L",
"country": "GB",
"fromDate": "2007-09-01",
"createdAt": "2020-01-04T17:24:29.146Z",
"updatedAt": "2020-01-04T17:24:29.146Z"
}
Last updated
Was this helpful?