Skip to end of banner
Go to start of banner

GET contact_information/validate_person_id_number

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

This method returns if the person id number is in a valid format

Available from CRM.COM R15.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

country_identifier

(mandatory)

Country identifier

The person's country for which the id number 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

id_number

(mandatory)

StringThe id number which is validated

Restrictions

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

Response Data

Name

Type

Description

boolean

String

Defines if the person id number is in valid format or not

 

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

   
  • No labels