Skip to main content

Overview

Allows the client to validate a personal number before using it to apply for a Legal Identity.

HTTP request

POST /Agent/Legal/ValidatePNr

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
	"countryCode": Required(Str(PCountryCode)),
	"pnr": Required(Str(PPNr))
}

Input parameters

ParameterDescription
PCountryCodeISO 3166-1 country code.
PPNrPersonal number entry to validate.

Response (JSON)

{
	"countrySupported": Required(Boolean(PCountrySupported)),
	"isValid": Optional(Boolean(PIsValid)),
	"normalized": Optional(Str(PNormalized))
}

Response parameters

ParameterDescription
PCountrySupportedIf country is supported and recognized by the personal number validator on the broker.
PIsValidIf the entry was found to be valid.
PNormalizedThe normal form of the personal number entry.

Notes

This endpoint uses the request schema notation described in Pattern matching.