Retrieve Person

Use this end point to retrieve or find a specific person. The end point may include request for all details, or with just the account details.

Request
Security:
path Parameters
person_guid
required
string <uuid>
version
required
string
Responses
200

Returns the Person

400

Bad request.

401

Unauthorized

404

Person not found

500

Server Error

get/api/{version}/persons/{person_guid}
Request samples
curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/persons/{person_guid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "identifications": [
    • {
      • "govt_id_type": "NOTPROVIDED",
      • "govt_id_number": "string"
      }
    ],
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "birth_date": "string",
  • "email": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "additional_data": {
    • "property1": "string",
    • "property2": "string"
    },
  • "mobile_number": "string",
  • "home_number": "string",
  • "office_number": "string",
  • "base_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "mailing_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "billing_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "nationality": "str",
  • "ip_address": "string",
  • "person_status": "INCOMPLETE",
  • "client_reference_id": "string",
  • "verfication_mode": "string",
  • "verfication_level": "string",
  • "person_forget_mode": "string",
  • "person_forget_mode_date": "string",
  • "market_notification_optin": "string",
  • "market_notification_optin_date": "string",
  • "address_lat": 0,
  • "address_lon": 0,
  • "contact_type": "string",
  • "profile_dd_mode": "string",
  • "request_code": "string",
  • "wallet_id": "string",
  • "title": "string",
  • "mask_govt_id_number": "string",
  • "comments": "string",
  • "jurisdiction_state": "string",
  • "jurisdiction_country": "str",
  • "beneficial_ownership": 100,
  • "person_relations": [
    • {
      • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
      • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
      • "person_relationship": "string",
      • "sys_utcinserted": "2019-08-24T14:15:22Z",
      • "sys_utcupdated": "2019-08-24T14:15:22Z"
      }
    ],
  • "mask_account_number": "string",
  • "ledger_balance": 0,
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.