Update a legal entity

put

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

Description

This endpoint enables the update of the legal entity declarative information..

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

legalEntityId

string

required

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-_.!§)(]*$

Body Params

Input

registrationNumber

string | null

Registration number

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

Cannot be modified if the KYB demand status is complete.

registrationCountry

string | null

^[A-Z]{2}$

Registration country of legal entity.

Format: 2 characters on ISO 3166-1 format

Cannot be modified if the KYB demand status is complete.

vatNumber

string | null

The VAT identification number of the legal entity

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

Cannot be modified if the KYB demand status is complete.

companyName

string | null

Legal entity company name

Cannot be modified if the KYB demand status is complete.

tradeName

string | null

Legal entity trade name

naceCode

string | null

Legal entity nace code

Cannot be modified if the KYB demand status is complete.

legalForm

string | null

Legal entity legal form

Cannot be modified if the KYB demand status is complete.

creationDate

string | null

Creation date of the legal entity

Cannot be modified if the KYB demand status is complete.

address

object

Head office address

registrationCity

string | null

Legal entity registration city

Cannot be modified if the KYB demand status is complete.

turnOver

double | null

Turn over N-1

highFinancialIncome

boolean | null

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 | null

Listed in stock markets

Possible values: "True" , "False"

Cannot be modified if the KYB demand status is complete.

isRegulated

boolean | null

Regulated

Possible values: "True" , "False"

Cannot be modified if the KYB demand status is complete.

currency

string | null

Currency

Cannot be modified if the KYB demand status is complete.

Headers

CorrId

string

Defaults to e10048ad-31cc-4233-81b0-97c66b7921b0

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

200

Legal entity updated successfully

Description
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 length of 'Registration Number' must be 150 characters or fewer. You entered X characters.
'Registration Country Code' is not in the correct format.
Unknown Country code: xx
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 length of 'Area' must be 50 characters or fewer. You entered X characters.
'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 invalid.
The ListedInStockMarkets field is invalid.
The IsRegulated field is invalid.
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

Description
LegalForm not allowed.
The KYB demand is already complete; only the following information could be modified: 'TradeName', 'TurnOver', 'Address'.
The KYB demand is fraudulent. Operation is not authorized.

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

404Not Found

405 Method Not Allowed: DescriptionLegalForm not allowed.The KYB demand is already complete; only the following information could be modified: 'TradeName', 'TurnOver', 'Address'.The KYB demand is fraudulent. Operation is not authorized.

500Internal Server Error