Create an address

Create an address

POST https://api.complycube.com/v1/addresses

Creates a new address.

Headers

Name	Type	Description
Content-Type	string	The content-type must always be set to application/json.
Authorization	string	The API live or test key

Request Body

Name	Type	Description
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.
postalCode	string	The zip or postcode of the client's address.
country	string	The country of the client's address. This will be the two-letter country ISO code.
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.

200 Address successfully created.

{
    "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"
}

400 An example of a Bad Request response, when an invalid address type is provided.

{
    "type": "invalid_request",
    "message": "'type' should be equal to one of the allowed values:main,alternative,other",
    "param": "type"
}

404 An example of a resource Not Found response, when an invalid clientId is provided.

{
    "type": "resource_not_found",
    "message": "Invalid client id '5eb1276d96be4a0008713af2'"
}

Example request

cURL

curl -X POST https://api.complycube.com/v1/clients \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"clientId":"5eb1276d96be4a0008713af5",
						"type": "main",
						"propertyNumber": "Flat 323",
						"line": "Common street",
						"city": "Aldgate",
						"state": "London",
						"postalCode": "W99 0RD",
						"country": "GB",
						"fromDate": "2007-09-01"
        }'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const address = await complycube.address.create("CLIENT_ID", {
    type: "main",
    propertyNumber: "Flat 323",
    line: "Common street",
    city: "Aldgate",
    state: "London",
    postalCode: "W99 0RD",
    country: "GB",
    fromDate: "2007-09-01"
});

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

new_address = {    
    'type': 'main',
    'propertyNumber': 'Flat 323',
    'line': 'Common street',
    'city': 'Aldgate',
    'state': 'London',
    'postalCode': "W99 0RD",
    'country': 'GB',
    'fromDate': '2007-09-01'
}

cc_api.addresses.create('CLIENT_ID',**new_address)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$result = $ccapi->address()->create('CLIENT_ID',['type' => 'main',
                                                 'line' => 'Common street',
                                                 'city' => 'Aldgate',
                                                 'country' => 'GB']);