GET contact_information/validate_passport_number

This method returns if the passport 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 country for which the passport number is validated. The allowed country identifier fields are the following:

Unable to render {include} The included page could not be found.

passport_number

(mandatory)

StringThe passport 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 passport number is in valid format or not

 

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

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