Skip to content

Get person

GET 
/api/apiGateway/getPersonInfo/{id}

Get the details of a person, identified by its id.

Parameters

id string

The unique identifier of the person that you want to retrieve.

Response

Type: application/json

Schema: PersonInfoResponseDto

success boolean

Indicates whether the request completed successfully.

error ErrorDto

id string

contactId string

firstName string

middleName string

lastName string

socialSecurityNumber string

Person contact social security number

description string

primaryPhoneNumber string

Person contact primary phone number

primaryEmail string

Person contact primary email address

image array [ string(byte) ]

address AddressDto

personalNetWorth number(double)

personalLiquidity number(double)

The total liquidity of the person

personalDSCR number(double)

Person DSCR

personalCashFlowAfterDebtService number(double)

Person cash flow after debt service

personDebtRatio number(double)

GET ${BASE_URL}/api/apiGateway/getPersonInfo/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7
Accept: */*
Authorization: Bearer eyJz93a...k4laUWw

curl --request GET \
    --url "${BASE_URL}/api/apiGateway/getPersonInfo/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7" \
    --header 'Accept: */*' \
    --header 'Authorization: Bearer eyJz93a...k4laUWw'
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": ["string"]
  },
  "id": "string",
  "contactId": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "socialSecurityNumber": "string",
  "description": "string",
  "primaryPhoneNumber": "string",
  "primaryEmail": "string",
  "image": ["string"],
  "address": {
    "fullAddress": "string",
    "placeId": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    },
    "zipCode": "string",
    "number": 0,
    "street": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "additionalFreeText": "string"
  },
  "personalNetWorth": 0,
  "personalLiquidity": 0,
  "personalDSCR": 0,
  "personalCashFlowAfterDebtService": 0,
  "personDebtRatio": 0
}