Create a legal entity

post

https://sb-api.xpollens.com/api/v2.0/legalentities

Disclaimer

This endpoint is not yet available for integration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Input

legalEntityId

string

required

length between 6 and 30

^[a-zA-Z0-9-_.!§)(]*$

Legal entity identifier from the Partner.

Format: min 6 characters, max 30 characters

Accepted characters: 0-9 a-z A-Z _ - . ! § ( )

Regex: ^[a-zA-Z0-9-_.!§)(]*$

registrationNumber

string

required

length between 1 and 150

Identification number of the legal entity.

This is the SIRET or SIREN if the registration country of the legal entity is France.

registrationCountry

string

required

length between 2 and 2

^[A-Z]{2}$

Registration country of legal entity.

It is on 2 characters on ISO 3166-1 format

vatNumber

string | null

The VAT identification number of the legal entity

Regex if RegistrationCountry == FR: ^FR[0-9A-Z]{2}[0-9]{9}$

companyName

string | null

CompanyName is corporate name of legal entity.

CompanyName is mandatory if RegistrationCountry != FR.

tradeName

string | null

TradeName is commercial name of legal entity.

TradeName is mandatory if RegistrationCountry != FR.

naceCode

string | null

NaceCode is type of economic activity of the legal entity.

NaceCode is mandatory if RegistrationCountry != FR.

legalForm

string | null

It is legal form of the legal entity.

LegalForm is mandatory if RegistrationCountry != FR.

creationDate

string | null

The creation date of the legal entity.

CreationDate is mandatory if RegistrationCountry != FR.

address

object

Address of the legal entity.

street, zipCode, city, country are mandatory if RegistrationCountry != FR

registrationCity

string | null

City of registration of the legal entity

turnOver

double

required

Turn over N-1

highFinancialIncome

boolean

required

High Financial Income

Possible values: "True" , "False"

If the legal entity is a financial institution, then "HighFinancialIncome" must be True.
If the legal entity is a passive non financial entity, then "HighFinancialIncome" must be True.
If the legal entity is an active non financial entity then "HighFinancialIncome" must be False.
If the legal entity is an exempted entity then "HighFinancialIncome" must be False.

listedInStockMarkets

boolean

required

Listed in stock markets

Possible values: "True" , "False"

isRegulated

boolean

required

Regulated

Possible values: "True" , "False"

currency

string

required

length ≥ 1

Currency code, based on ISO 4217

Currently, just one value is possible: "EUR"

Headers

CorrId

string

Defaults to 9cc36eac-f3d8-4620-99ed-d9f1407f0dae

Correlation Id

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

202

Demand Accepted

Description
The legalEntityId field is required.
The length of 'legalEntityId' must be at least 6 characters. You entered X characters.
The length of 'legalEntityId' must be 30 characters or fewer. You entered X characters.
'legalEntityId' is not in the correct format. Accepted characters : a-zA-Z0-9-_.!§)(
The RegistrationNumber field is required.
The length of 'Registration Number' must be 150 characters or fewer. You entered X characters.
The registrationCountry field is required.
'Registration Country Code' is not in the correct format.
Unknown Country code: xx
The turnOver field is required.
The turnOver field is invalid.
'Turn Over' must not be more than 18 digits in total, with allowance for 2 decimals. X digits and Y decimals were found.
'Company Name' must not be empty.
The length of 'Company Name' must be 150 characters or fewer. You entered X characters.
'Trade Name' must not be empty.
The length of 'Trade Name' must be 150 characters or fewer. You entered X characters.
'Nace Code' must not be empty.
The length of 'Nace Code' must be 30 characters or fewer. You entered X characters.
'Legal Form' must not be empty.
The length of 'Legal Form' must be 100 characters or fewer. You entered X characters.
'Creation Date' must not be empty.
'Creation Date' must be less than now.
'Address' must not be null.
The Street field is required.
The ZipCode field is required.
The City field is required.
The length of 'Area' must be 50 characters or fewer. You entered X characters.
The Country field is required.
'Country Code' is not in the correct format.
The length of 'Registration City' must be 50 characters or fewer. You entered X characters.
The HighFinancialIncome field is required.
The HighFinancialIncome field is invalid.
The ListedInStockMarkets field is required.
The ListedInStockMarkets field is invalid.
The IsRegulated field is required.
The IsRegulated field is invalid.
The Currency field is required.
The length of 'Currency' must be 3 characters or fewer. You entered X characters.
The currency must be EUR.
LegalEntityId already exists
RegistrationNumber already exists
The Legal entity's country of registration is not allowed
LegalForm not allowed

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

500Internal Server Error