Getting Started


Searching for Payees

This GET Get a list of Payees based on specified country and additional criteria. API method supports searching and identifying payees within a specified country. Search results will be sorted on highest confidence matching level.

Search or Filter criteria

The following search criteria are supported to identify an payee registered within our customer management domain and within a specified country:

  • Search based on jurisdiction_identifier and jurisdiction_identifier_type (e.g. company identifier in a specific country); examples are chamber of commerce number or KVK (NL), Siret (FR), CIF (ES), VAT Number (BE), Tax Number (US) and Company Registration Number (GB)
  • Search based on name
  • The following validation rules apply while providing the search criteria:
    • The country_of_registration is required and at least one of the other search criteria must be provided.
    • if jurisdiction_identifier is provided, then jurisdiction_identifier_type MUST also be specified.
    • name is required if either jurisdiction_identifier is not provided.

Jurisdiction Identifier Types

The jurisdiction identifier types that are supported per country are described below:

Country CodeCountrySupportedDefault
BEBelgiumvat-numbervat-number
ESSpaincif, nifcif
FRFrancesiretsiret
GBUnited Kingdomorganization-numberorganization-number
IEIrelandorganization-numberorganization-number
ITItalyfiscal-codefiscal-code
NLNetherlandschamber-of-commerce-numberchamber-of-commerce-number
PTPortugalcif, nifcif
USUnited Statestax-number, ssntax-number

Sample Request