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

• Array [
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 string
UUID
Address1 string
Address1
Address2 stringnullable
Address2
Address3 stringnullable
Address3
ZipCode stringnullable
Zip Code
City stringnullable
City
Tag stringnullable
Tag
uuid stringnullable
]
AliasIBAN object[]
Array [
UUID string
Iban string
Iban
BIC string
BIC
Actif booleannullable
is Actif (default = true)
Public booleannullable
is Public (default = false)
uuid stringnullable
]
AliasEmail object[]
Array [
UUID string
Owner string
NaturalPerson or LegalEntity UUID
Mail string
Mail
Actif boolean
is Actif (default = true)
Public boolean
is Public (default = false)
valid booleannullable
is Valid (default = false)
uuid stringnullable
]
AliasMobile object[]
Array [
UUID string[]
UUID
MobileIndicatif string
MobileIndicatif
MobileNumber string
MobileNumber
Actif boolean
is Actif (default = true)
Public boolean
is Public (default = false)
uuid stringnullable
]
NIF stringnullable
Comments stringnullable
CodeLangue stringnullable
ActivityCode integernullable

Activity Code

CSPCode integernullable

CSP Code

codeShop stringnullable

Code Shop

idBB stringnullable

Id BB

ibanOlkyPay stringnullable

IBAN Oky Pay

countryOfBirth stringnullable

Country of birth

identityUuid stringnullable
idLausanne stringnullable

Id Lausane

uuid stringnullable
• ]

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",
        "City": "Paris",
        "Tag": "Home",
        "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
      }
    ],
    "AliasIBAN": [
      {
        "UUID": "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",
        "valid": "true",
        "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
      }
    ],
    "AliasMobile": [
      {
        "UUID": "string",
        "MobileIndicatif": "+33",
        "MobileNumber": "0612345678",
        "Actif": "true",
        "Public": "true",
        "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
      }
    ],
    "NIF": "string",
    "Comments": "string",
    "CodeLangue": "string",
    "ActivityCode": "2",
    "CSPCode": "2",
    "codeShop": "XYZ",
    "idBB": "XYZ",
    "ibanOlkyPay": "TVW XYZ 123 456",
    "countryOfBirth": "TN",
    "identityUuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
    "idLausanne": "XYZ",
    "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": "409",
  "internal_code": "3001",
  "message": "Incorect data"
}

Loading...