Get one Natural Person with his UUID

GET 
/sint/naturalPerson/:uuid

Get one Natural Person with his UUID

Request

Path Parameters

uuid stringrequired

The UUID of the Abstract entity of the natural person you want to get

Responses

200

Return a Natural person

application/json

Schema

Schema

Gender stringnullable

The person gender

LastName stringnullable

Last name

FirstName stringnullable

First name

OtherFirstNames stringnullable

Other first name

MaidenName stringnullable

Maiden name

DateOfBirth date-timenullable
CountryOfCitizenship stringnullable

Country of citizenship

CountryOfCitizenship2 stringnullable

Second country of citizenship

Birthplace stringnullable

Birthplace

StateOfBirth stringnullable

State of birth

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
]
NIF stringnullable
Comments stringnullable
CodeLangue stringnullable
ActivityCode integernullable

Activity Code

CSPCode integernullable

CSP Code

SourceIncomeCode integernullable

Source Income Code

codeShop stringnullable

Code Shop

idBB stringnullable

Id BB

ibanOlkyPay stringnullable

IBAN Oky Pay

countryOfBirth stringnullable

Country of birth

identityUuid stringnullable
algoregId stringnullable

Id Algoreg

idLausanne stringnullable

Id Lausane

pep booleannullable

true if person is politically exposed

minimumMonthlyIncome integernullable

low range of the person's income, in cents

maximumMonthlyIncome integernullable

Max range of the person's income, in cents

minimumWealthValue integernullable

low range of the person's wealth value, in cents

maximumWealthValue integernullable

Max range of the person's wealth value, in cents

own_external_sepa_account booleannullable

Has european account

nif_country stringnullable

Nif country

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[]

Example (from schema)

{
  "Gender": "Mr",
  "LastName": "DOE",
  "FirstName": "John",
  "OtherFirstNames": "Bar Waldo",
  "MaidenName": "Foo",
  "DateOfBirth": "1994-03-24",
  "CountryOfCitizenship": "FR",
  "CountryOfCitizenship2": "LU",
  "Birthplace": "Paris",
  "StateOfBirth": "Île-de-France",
  "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"
    }
  ],
  "NIF": "string",
  "Comments": "string",
  "CodeLangue": "string",
  "ActivityCode": "2",
  "CSPCode": "2",
  "SourceIncomeCode": "2",
  "codeShop": "XYZ",
  "idBB": "XYZ",
  "ibanOlkyPay": "TVW XYZ 123 456",
  "countryOfBirth": "FR",
  "identityUuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
  "algoregId": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
  "idLausanne": "XYZ",
  "pep": "false",
  "minimumMonthlyIncome": "150000",
  "maximumMonthlyIncome": "300000",
  "minimumWealthValue": "2000000",
  "maximumWealthValue": "10000000",
  "own_external_sepa_account": "true",
  "nif_country": "LU",
  "olkyPassLevel": {}
}

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": "409",
  "internal_code": "3001",
  "message": "Incorect data"
}

Loading...