Create an address

URL

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.

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. 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.
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.

Example request

cURL

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

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'
]);

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.Addresses;

var addressApi = new AddressApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var addressRequest = new AddressRequest {
  clientId = "CLIENT_ID",
  type = "main",
  propertyNumber = "Flat 323",
  line = "Common street",
  city = "Aldgate",
  state = "London",
  postalCode = "W99 0RD",
  country = "GB",
  fromDate = new DateTime(2007, 09, 01);
};

var address = await addressApi.CreateAsync(newRequest);

Example responses

Success (200)

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

Invalid Request (400)

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

Resource Not Found (404)

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