GET contact_information/validate_address_post_code

This method returns if the address post code is in a valid format

Available from CRM.COM R15.0.0

Resource URL

Name

Type

Description

token

String

The token retrieved from the login method

address_type

(mandatory)

String

The address type for which the post code is validated

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

country_identifier

(mandatory)

Country identifier

The country of the address which the post code is validated. The allowed country identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the country
name (semi-optional)	String	The name of the country
alternative_code (semi-optional)	String	The alternative code of the retrieved country
two_character_code (semi-optional)	String	The two character code of the retrieved country
three_character_code (semi-optional)	String	The three character code of the retrieved country

post_code_number

(mandatory)

String

The post code number which is validated

It is mandatory to specify one of the semi-optional parameters. Multiple semi-optional parameters can be specified in each call

Name	Type	Description
boolean	String	Defines if the address post code is in valid format or not

Example 1

HTTP Method: GET

Request:

Response:

    {
    "data": {
        "is_valid": true
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}