Update an address

URL

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

Updates the specified address by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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.

Path parameters

Name	Type	Description
id*	string	The ID of the address.

Body

Name	Type	Description
type	string	The type of address. Valid values include: 1. main 2. alternative 3. other
propertyNumber	string	The property number for this address.
buildingName	string	The building name for this 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/addresses/{:addressId} \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"propertyNumber": "Flat 57",
          	"toDate": "2020-01-01"
        }'

Node.js

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

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

const address = await complycube.address.update("ADDRESS_ID", {
    propertyNumber: "Flat 57",
    toDate: "2020-01-01"
});

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

updated_address = cc_api.addresses.update(
    'ADDRESS_ID', 
    propertyNumber='Flat 57', 
    toDate='2020-01-01'
)

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$address = $ccapi->address()->update(['country' => 'US']);

.NET

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

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

var update = new AddressRequest {
  propertyNumber = "Flat 57",
  toDate = new DateTime(2020, 01, 01);
};

var address = await addressApi.UpdateAsync(update);

Example response

Success (200)

{
    "id": "5eb1276f96be4a0008713af6",
    "clientId": "5eb1276d96be4a0008713af5",
    "type": "main",
    "propertyNumber": "Flat 57",
    "line": "Common street",
    "city": "Aldgate",
    "state": "London",
    "postalCode": "W10 11L",
    "country": "GB",
    "fromDate": "2007-09-01",
    "toDate": "2020-01-01",
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:13:10.712Z"
}

Resource Not Found (404)

{
    "type": "resource_not_found",
    "message": "Invalid address id '5eb1276f96be4a0008713af5'"
}