Validate the format of User data

POST /v2.01/{ClientId}/users/data-formats/validation

REST

{
    "CompanyNumber": {
        "CompanyNumber": "AB123456",
        "CountryCode": "IT"
    }
}  

200 - Valid format for the country

{
    "CompanyNumber": {
        "CompanyNumber": "12345678",
        "CountryCode": "GB",
        "IsValid": true,
        "ValidationRules": [
            "^[0-9]{8}$|^[0-9]{7}$|^SC[0-9]{6}$|^NI[0-9]{6}$|^OC[0-9]{6}$|^R[0-9]{7}$|^IP[0-9]{5}R$|^SO[0-9]{6}$"
        ]
    }
}

This endpoint allows you to check that the format of the CompanyNumber is correct and retrieve the validation rules applied to it.

The CompanyNumber must be in the correct format for Business Legal Users to be KYC/B verified.

Caution – Veracity of data checked during verification

This endpoint only checks that the format of the data corresponds to that which is expected. Whether or not the data is true and correct for the specific User is checked during the user verification process when documents are submitted.

Body parameters

CompanyNumber · object

Information about the registration number of a legal entity. For details, see the Company number article.

Show properties

CompanyNumber · string · required

The registration number of a legal entity, assigned by the relevant national authority.

Note: Any non-alphanumeric characters, like dashes or spaces, are removed before applying the validation rules.

CountryCode · string · required

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the registration of the legal entity, against which the company number format is validated.

Responses

200 - Valid format for the country

CompanyNumber · string

Information about the registration number of a legal entity. For details, see the Company number article.

Show properties

CompanyNumber · string

The registration number of a legal entity, assigned by the relevant national authority.

Note: Any non-alphanumeric characters, like dashes or spaces, are removed before applying the validation rules.

CountryCode · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the registration of the legal entity, against which the company number format is validated.

IsValid · boolean

Whether the format of the value is valid for the country.

ValidationRules · array

The list of regular expressions applicable to the country. Rules only exist for countries listed in the Company number article.

Note: Any non-alphanumeric characters, like dashes or spaces, are removed before applying the validation rules.

400 - Country code not recognized

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "0421656b-5f32-4475-874c-561449f9ffbf",
    "Date": 1697101284.0,
    "errors": {
        "CompanyNumber.CountryCode": "The requested value is not an ISO 3166-1 alpha-2 code which is expected."
    }
}  

200 - Valid format for the country

{
    "CompanyNumber": {
        "CompanyNumber": "12345678",
        "CountryCode": "GB",
        "IsValid": true,
        "ValidationRules": [
            "^[0-9]{8}$|^[0-9]{7}$|^SC[0-9]{6}$|^NI[0-9]{6}$|^OC[0-9]{6}$|^R[0-9]{7}$|^IP[0-9]{5}R$|^SO[0-9]{6}$"
        ]
    }
}

REST

{
    "CompanyNumber": {
        "CompanyNumber": "AB123456",
        "CountryCode": "IT"
    }
}