Overview
This section documents the common parameters used across Trustpair API endpoints. Understanding these parameters is essential for constructing valid API requests and processing responses correctly.
Common Parameters
Parameters for Legal entity
Format Options
The Trustpair API accepts Legal entity details in the following formats:
| Format | Description | Structure | Example | Use case |
|---|---|---|---|---|
| Local ID | A Local ID is a national identifier assigned to a company by a local government or registration authority. Its format and name vary by country (e.g., SIREN in France, EIN in the United States of America) | Varies by country | (French SIREN) company_registration: "552100554" | Best used when you want to rely on a country-specific business registry |
| VAT number | A VAT Number is a value-added tax identifier assigned to businesses for tax purposes within the EU and other regions. It’s often used for intra-European trade and regulatory reporting. | Usually starts with a country code followed by alphanumeric characters | tax_number: "FR73552100554" | Commonly used for cross-border transactions within the EU |
| DUNS number | A DUNS Number is a global business identifier issued by Dun & Bradstreet. It provides a unique nine-digit number for each physical location of a business. | 9 digits, no letters or special characters | duns_number: "123456789" | Ideal for international use or when working with global partners |
Required Fields
Every request must include valid legal entity details in at least one of the supported formats. Requests missing valid legal entity information information will return an error.
Parameters for Individuals
Format Options
The Trustpair API accepts Individual details in the following formats:
| Format | Description | Structure | Example |
|---|---|---|---|
| First name | The given name of the individual. | Alphabetic string (accents and diacritics allowed) | first_name: "John" |
| Last name | The family name or surname of the individual. | Alphabetic string (accents and diacritics allowed) | last_name: "DOE" |
| Tax Number | A personal tax identifier assigned to individuals by tax authorities. The format varies by country (e.g., NIF in Spain, SSN in the U.S.). | Country-specific (alphanumeric or numeric) | natural_person_tax_number: "12345678901" |
Required Fields
Every request must include the Individual's first name and last name. Requests missing valid Individual information information will return an error.
Parameters for bank accounts
Format Options
The Trustpair API accepts bank account details in the following formats:
| Format | Description | Example |
|---|---|---|
| IBAN | A standardized international bank account number. Used primarily in Europe and other countries. | iban: "FR7630006000011234567890189" |
| Account Number + BIC | Account Number: The institution-specific account identifier BIC (Bank Identifier Code): The international identifier for the financial institution | {bank_account_number: "12345678", bank_account_bic: "BNPAFRPP"} |
| Account Number + Routing Number | Account Number: The institution-specific account identifier Routing Number: The national bank identifier (primarily used in the US) | {bank_account_number: "12345678", routing_number: "021000021"} |
Required Fields
Every request must include valid bank account details in at least one of the supported formats. Requests missing valid bank account information will return an error.
Validation and Selection Logic
When multiple bank account formats are provided in a single request, the system applies the following rules:
- Format Prioritization: The system validates and selects only one format per bank account according to this priority order:
- IBAN (highest priority)
- Account Number + BIC (second priority)
- Account Number + Routing Number (lowest priority)
- Processing Behavior: The system processes only the highest-priority valid format and ignores other formats, even if they are also valid.
- Error Handling: If the highest-priority format contains errors, the system will attempt to use the next highest-priority format provided.