Get Business Registration Number Types

GlobalGateway supports different business registration number types in each country. To see what business registration numbers are supported for a specific country, you can run the Get Business Registration Numbers request.

Request

GET <<endpoint>>configuration/v1/businessRegistrationNumbers/BR
Authorization: Basic ACCESS_TOKEN

The country code is mandatory but jurisdiction is optional.

GET <<endpoint>>configuration/v1/businessRegistrationNumbers/CA/BC
Authorization: Basic ACCESS_TOKEN

Response

[
    {
        "Name": "CNPJ (Cadastro Nacional da Pessoa Jurídica)",
        "Description": "0",
        "Country": "Brazil",
        "Supported": true,
        "Type": "Tax number",
        "Masks": [
            {
                "Mask": "##############",
                "IgnoreWhitespace": true,
                "IgnoreSpecialCharacter": true
            }
        ]
    }
]

The request returns an array containing the different types of Business Registration Numbers supported for a specified country.

Interpreting Mask Values

The Mask field displays the most common layouts for the Business Registration Number. The following table will help you understand the meaning of each character:

Mask Value

Definition

Example

Numeric character

A mask value of ###### indicates that the business registration number consists of six numeric characters.
Example:123456

A

Alpha character

A mask value of AA##### indicates that the business registration number consists of two alpha characters followed by five numeric characters.

Example: BC12345

a

Alphanumeric character

A mask value of #####a indicates the business registration number consists of five numeric characters followed by an alphanumeric character.

Example: 12345B or 123456

Special characters are mirrored. The mask value for business registration numbers with special characters are displayed as:

  • Business Registration Number: IT-123456/7
  • Mask Value: AA-######/#

Did this page help you?