Validate the format of User data

POST

/v2.01/:ClientId/users/data-formats/validation

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.

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.

<Warning icon="fa-regular fa-triangle-exclamation"> **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. </Warning> Validate the format of User data 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

CompanyNumberobjectOptional

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

Response

Success

CompanyNumberobject

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

Errors

400

Bad Request Error

$	curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/users/data-formats/validation \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"body": {
>	"CompanyNumber": {
>	"CompanyNumber": "AB123456",
>	"CountryCode": "IT"
>	}
>	}
>	}'

1	{
2	"CompanyNumber": {
3	"CompanyNumber": "12345678",
4	"CountryCode": "GB",
5	"IsValid": true,
6	"ValidationRules": [
7	"^[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}$"
8	]
9	}
10	}