Search Persons

This end point allows you to search for one or more persons, using a search critera. The search criteria must be included in the body of the request.

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
person_guid
string or null <uuid>

Unique Id of the person

first_name
string or null

First name of the person

last_name
string or null

Last name of the person

client_reference_id
string or null

Client unique Id of the person

address_line1
string or null <= 48 characters

Address information of the person. Full number and name of street, avenue, road etc

address_line2
string or null <= 48 characters

Additional address information

city
string or null <= 30 characters

City corresponding to the address

postal_code
string or null <= 10 characters

Postal code corresponding to the address.

state
string or null [ 2 .. 30 ] characters

State name

country
string or null 3 characters

Country corresponding to the address. Must be entered as ISO 3-letter country code.

email_address
string or null

Email of the person

mobile_number
string or null

Mobile number of the person

company_short_name
string or null

Company of the person

birth_date
string or null <date-time>

Birth date of the person

home_number
string or null

Home number of the person

phone_number
string or null

Phone number of the person to search against home, mobile and office numbers

wallet_id
string or null

Wallet Id

card_number
string or null

Card number

card_proxy
string or null

Card proxy

govt_id_number
string or null

Government Id of the person

customer_search
string or null

Customer search

user_guid
string or null <uuid>

Unique Id of the user

account_guid
string or null <uuid>

Account unique Id

contact_type
string or null

Contact type of the person. "INDIVIDUAL", "INVENTORYMANAGER", "CORPORATE", "PROGRAMPERSON", "UBODIRECTOR"

title
string or null

Title of the person

limit
integer <int32> [ 1 .. 1000 ]

Limit number of results to retrieve (Will be defaulted to 100 if none specified)

start_index
integer <int32>

Index used for pagination of the result.

wallet_guid
string or null <uuid>

Wallet unique Id

company_guid
string or null <uuid>

company unique Id

program_guid
string or null <uuid>

program unique Id

additional_data_key
string or null

Additional data key

additional_data_value
string or null

Additional data value

account_instrument_guid
string or null <uuid>

account instrument unique Id

account_type
Array of strings or null (AccountType)

Account Types.

Enum: "GENERAL" "PROGFUND" "CHECK" "REVENUE" "COLLECTION" "PRINCIPAL" "SECURE" "CREDIT" "USERDEFINED" "ADVANCE" "PROG_DISBURSE" "EXCEPTION" "WRITEOFF" "SUSPENSE"
account_status
Array of strings or null (AccountStatus)

Account statuses

Enum: "SYSTEM" "ACTIVE" "FREEZE" "CLOSED" "OPTOUT"
account_routing_number
string or null <= 9 characters

account instrument routing number (bank)

account_instrument_number
string or null

account instrument number

outside_instrument_guid
string or null <uuid>

outside instrument unique Id

outside_instrument_number
string or null

bank outside instrument number

outside_card_number
string or null

card outside instrument number

has_comments
boolean or null

Has comments added for person

min_ledger_balance
number or null <double>

Minimum Ledger balance. (Ledger balance also called Account balance. This include funds that are authorized, but not yet cleared)

max_ledger_balance
number or null <double>

Maximum Ledger balance (Ledger balance also called Account balance. This include funds that are authorized, but not yet cleared)

Responses
200

Returns the Person

400

Bad request

401

Unauthorized

404

Person not found

500

Server Error

post/api/{version}/persons/search
Request samples
application/json
{
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "first_name": "string",
  • "last_name": "string",
  • "client_reference_id": "string",
  • "address_line1": "string",
  • "address_line2": "string",
  • "city": "string",
  • "postal_code": "string",
  • "state": "string",
  • "country": "str",
  • "email_address": "string",
  • "mobile_number": "string",
  • "company_short_name": "string",
  • "birth_date": "2019-08-24T14:15:22Z",
  • "home_number": "string",
  • "phone_number": "string",
  • "wallet_id": "string",
  • "card_number": "string",
  • "card_proxy": "string",
  • "govt_id_number": "string",
  • "customer_search": "string",
  • "user_guid": "2c9a19c5-ac85-4da0-8708-2b80265927da",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "contact_type": "string",
  • "title": "string",
  • "limit": 1,
  • "start_index": 0,
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "additional_data_key": "string",
  • "additional_data_value": "string",
  • "account_instrument_guid": "e5662964-577d-4724-b8d5-e791eee05564",
  • "account_type": [
    • "GENERAL"
    ],
  • "account_status": [
    • "SYSTEM"
    ],
  • "account_routing_number": "string",
  • "account_instrument_number": "string",
  • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
  • "outside_instrument_number": "string",
  • "outside_card_number": "string",
  • "has_comments": true,
  • "min_ledger_balance": 0,
  • "max_ledger_balance": 0
}
Response samples
application/json
{
  • "count": 0,
  • "start_index": 0,
  • "end_index": 0,
  • "has_more": true,
  • "data": [
    • {
      • "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",
      • "wallet_id": "string",
      • "title": "string",
      • "mask_govt_id_number": "string",
      • "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"
          }
        ],
      • "top_program_name": "string",
      • "program_name": "string",
      • "last4_card": "string",
      • "last_card_status": "string",
      • "mask_card_pan": "string",
      • "available_balance": 0,
      • "account_status": "string",
      • "account_type": "string",
      • "account_currency": "string",
      • "comments": "string",
      • "mask_account_number": "string",
      • "ledger_balance": 0,
      • "jurisdiction_state": "string",
      • "jurisdiction_country": "string",
      • "beneficial_ownership": 0
      }
    ],
  • "check_statuses": [
    • "string"
    ]
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.