Get one Legal entity with his UUID

GET 
/sint/legalEntity/:uuid

Get one Legal entity with his UUID

Request

Path Parameters

uuid stringrequired

The UUID of the Legal entity you want to get

Responses

200

Return a Legal entity

application/json

Schema

Schema

• Array [
LegalName stringnullablerequired

LegalName

Brand stringnullablerequired

Brand

Country stringnullablerequired

Country alpha-2

LegalForm stringnullable

LegalForm

RCSlocation stringnullable

RCSlocation

RCSnumber stringnullable

RCSnumber

IsIncorporated booleannullablerequired

Is the company fully incorporated ?

DateOfIncorporation date-timenullable

DateConstitution

ShareCapital integernullable

The share capital of the company, in cents

IsListedOnStockExchange booleannullable

Is the company listed on the stock exchange

PlaceOfQuotation stringnullable

Place of quotation on the stock exchange

VATSubject booleannullable

Is the company subject to VAT

VATNumber stringnullable

VAT number including country prefix

NIF stringnullable

Tax number

Comments stringnullable

Free text

ActivityCode integernullable

Activity Code

CSPCode integernullable

CSP Code

CodeLangue stringnullable

Code langague talk

Address object[]
Array [
UUID string
UUID
Address1 stringrequired
Address1
Address2 stringnullable
Address2
Address3 stringnullable
Address3
ZipCode stringnullable
Zip Code
Country stringrequired
Country
City stringnullable
City
AbstractEntityUUID string
NaturalPerson or LegalEntity UUID
Tag stringnullable
Tag
uuid stringnullable
]
AliasIBAN object[]
Array [
UUID string
Owner stringrequired
NaturalPerson or LegalEntity UUID
Iban stringrequired
Iban
BIC stringrequired
BIC
Actif booleannullable
is Actif (default = true)
Public booleannullable
is Public (default = false)
uuid stringnullable
]
AliasEmail object[]
Array [
UUID string
Owner stringrequired
NaturalPerson or LegalEntity UUID
Mail stringrequired
Mail
Actif boolean
is Actif (default = true)
Public boolean
is Public (default = false)
LinkNPLE string
NPLE link UUID
valid booleannullable
is Valid (default = false)
uuid stringnullable
]
AliasMobile object[]
Array [
UUID string[]
UUID
Owner stringrequired
NaturalPerson or LegalEntity UUID
MobileIndicatif stringrequired
MobileIndicatif
MobileNumber stringrequired
MobileNumber
Actif boolean
is Actif (default = true)
Public boolean
is Public (default = false)
LinkNPLE string
NPLE link UUID
uuid stringnullable
]
identityUuid stringnullable
websiteUrl stringnullable

Website url

mailAddress stringnullable

Principal email

codeNace stringnullable

code Nas

uuid stringnullable
• ]

Example (from schema)

[
  {
    "LegalName": "Olky Payment Service Provider",
    "Brand": "Olkypay",
    "Country": "FR",
    "LegalForm": "Limited Company",
    "RCSlocation": "Nantes",
    "RCSnumber": "RC NANTES 234 987 456",
    "IsIncorporated": "true",
    "DateOfIncorporation": "2011-05-23",
    "ShareCapital": "1000000",
    "IsListedOnStockExchange": "true",
    "PlaceOfQuotation": "Paris",
    "VATSubject": "true",
    "VATNumber": "IE1234567T",
    "NIF": "12345678",
    "Comments": "free text for legal entity",
    "ActivityCode": "2",
    "CSPCode": "2",
    "CodeLangue": "EN",
    "Address": [
      {
        "UUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "Address1": "Champ de Mars",
        "Address2": "5 Av. Anatole France",
        "Address3": "",
        "ZipCode": "75007",
        "Country": "LU",
        "City": "Paris",
        "AbstractEntityUUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "Tag": "Home",
        "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
      }
    ],
    "AliasIBAN": [
      {
        "UUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "Owner": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "Iban": "FR7630006000011234567890189",
        "BIC": "OLKILUL1",
        "Actif": "true",
        "Public": "true",
        "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
      }
    ],
    "AliasEmail": [
      {
        "UUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "Owner": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "Mail": "j.doe@example.com",
        "Actif": "true",
        "Public": "true",
        "LinkNPLE": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "valid": "true",
        "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
      }
    ],
    "AliasMobile": [
      {
        "UUID": "string",
        "Owner": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "MobileIndicatif": "+33",
        "MobileNumber": "0612345678",
        "Actif": "true",
        "Public": "true",
        "LinkNPLE": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
        "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
      }
    ],
    "identityUuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
    "websiteUrl": "www.example.com",
    "mailAddress": "john.doe@olky.eu",
    "codeNace": "A",
    "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
  }
]

401

Unauthorized

application/json

Schema

Schema

code integer
message string

Example (from schema)

{
  "code": "401",
  "message": "JWT Token not found"
}

4XX|5XX

An error occured

application/json

Schema

Schema

success boolean
code integer
internal_code integer
message string

Example (from schema)

{
  "success": "false",
  "code": "400",
  "internal_code": "3001",
  "message": "Incorect data"
}

Loading...