Search Persons

post

https://devapi.qolopay.com/api/{version}/persons/search

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

required

Body Params

person_guid

uuid | null

Unique Id of the person

first_name

string | null

First name of the person

last_name

string | null

Last name of the person

client_reference_id

string | null

Client unique Id of the person

address_line1

string | null

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

address_line2

string | null

Additional address information

city

string | null

City corresponding to the address

postal_code

string | null

Postal code corresponding to the address.

state

string | null

State name

country

string | null

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

email_address

string | null

Email of the person

mobile_number

string | null

Mobile number of the person

company_short_name

string | null

Company of the person

birth_date

date-time | null

Birth date of the person

home_number

string | null

Home number of the person

phone_number

string | null

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

wallet_id

string | null

Wallet Id

card_number

string | null

Card number

card_proxy

string | null

Card proxy

govt_id_number

string | null

Government Id of the person

customer_search

string | null

Customer search

user_guid

uuid | null

Unique Id of the user

account_guid

uuid | null

Account unique Id

contact_type

string | null

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

title

string | null

Title of the person

limit

int32

1 to 1000

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

start_index

int32

Index used for pagination of the result.

wallet_guid

uuid | null

Wallet unique Id

company_guid

uuid | null

company unique Id

program_guid

uuid | null

program unique Id

additional_data_key

string | null

Additional data key

additional_data_value

string | null

Additional data value

account_instrument_guid

uuid | null

account instrument unique Id

account_type

array of objects | null

Account Types.

account_type

account_status

array of objects | null

Account statuses

account_status

Allowed:

account_routing_number

string | null

account instrument routing number (bank)

account_instrument_number

string | null

account instrument number

outside_instrument_guid

uuid | null

outside instrument unique Id

outside_instrument_number

string | null

bank outside instrument number

outside_card_number

string | null

card outside instrument number

has_comments

boolean | null

Has comments added for person

min_ledger_balance

double | null

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

max_ledger_balance

double | null

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

interest_rate_code

string | null

Interest Rate Code

min_interest_rate

double | null

Minimum Interest Rate

max_interest_rate

double | null

Maximum Interest Rate

supplemental_details

object

exclude_hierarchy_check

boolean | null

Indicates whether to exclude a program hierarchy check and only return results linked to program guid provided

exclude_beneficial_owner

boolean | null

Indicates whether to exclude a beneficial owner person type from the search results

Responses

500

Server Error

200Returns the Person

400Bad request

401Unauthorized

404Person not found