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

LegalName stringrequired

LegalName

Brand stringrequired

Brand

Country stringrequired

Country alpha-2

LegalForm stringnullable

LegalForm

RCSlocation stringnullable

RCSlocation

RCSnumber stringnullable

RCSnumber

IsIncorporated booleanrequired

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 stringrequired
UUID
Address1 stringrequired
Address1
Address2 stringnullable
Address2
Address3 stringnullable
Address3
ZipCode stringnullable
Zip Code
Country stringrequired
Country
City stringnullable
City
AbstractEntityUUID stringrequired
NaturalPerson or LegalEntity UUID
Tag stringnullable
Tag
isPrincipalAddress booleannullable
Default value: false
isPrincipalAddress
]
AliasIBAN object[]
Array [
UUID string
Owner string
NaturalPerson or LegalEntity UUID
Iban stringrequired
Iban
BIC stringrequired
BIC
Actif booleannullable
Default value: true
is Actif (default = true)
Public booleannullable
Default value: false
is Public (default = false)
BankInfoDto object nullable
oneOf
BankInfoDto2
Address stringnullable
address1
CountryName stringnullable
countryName
Institution stringnullable
institution
Location stringnullable
location
Name stringnullable
name
valid booleannullable
Default value: false
is Valid (default = false)
fail_validation_reason stringnullable
fail_validation_reason
]
AliasEmail object[]
Array [
UUID string
Owner stringrequired
NaturalPerson or LegalEntity UUID
Mail stringrequired
Mail
Actif boolean
Default value: true
is Actif (default = true)
Public boolean
Default value: false
is Public (default = false)
LinkNPLE string
NPLE link UUID
valid booleannullable
Default value: false
is Valid (default = false)
]
AliasMobile object[]
Array [
UUID string[]
UUID
Owner stringrequired
NaturalPerson or LegalEntity UUID
MobileIndicatif stringrequired
MobileIndicatif
MobileNumber stringrequired
MobileNumber
Actif boolean
Default value: true
is Actif (default = true)
Public boolean
Default value: false
is Public (default = false)
LinkNPLE string
NPLE link UUID
]
olkyPassLevel object nullable
OlkypassLevel
oneOf
OlkyPassLevelDto2
active booleannullable
OlkyPass need to be active to make transaction on customer
activeUntil date-timenullable
The OlkyPass will expire after this date, a new kyc session will need to be done to activate it again
createdAt date-timenullable
Created at
updatedAt date-timenullable
updated at
missingData string[]
Default value: ``
missingDocuments string[]
Default value: ``
identityDocuments object[]
ValidForPayIn boolean
Default value: true
ValidForPayout boolean
Default value: true
olkypass_status object[]
Array [
name stringnullable
French name
englishName stringnullable
English name
createdAt date-timenullable
Created at
updatedAt date-timenullable
Updated at
deletedAt date-timenullable
Deleted at
]
olkypass_status_under_audit string[]
identityUuid stringnullable
websiteUrl stringnullable

Website url

mailAddress stringnullable

Principal email

codeNace stringnullable

code Nas

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",
      "isPrincipalAddress": "false"
    }
  ],
  "AliasIBAN": [
    {
      "UUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
      "Owner": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
      "Iban": "FR7630006000011234567890189",
      "BIC": "OLKILUL1",
      "Actif": "true",
      "Public": "true",
      "BankInfoDto": {},
      "valid": "true",
      "fail_validation_reason": "XYZZZ"
    }
  ],
  "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"
    }
  ],
  "AliasMobile": [
    {
      "UUID": "string",
      "Owner": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
      "MobileIndicatif": "+33",
      "MobileNumber": "0612345678",
      "Actif": "true",
      "Public": "true",
      "LinkNPLE": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
    }
  ],
  "olkyPassLevel": {},
  "identityUuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
  "websiteUrl": "www.example.com",
  "mailAddress": "john.doe@olky.eu",
  "codeNace": "A"
}

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