Skip to navigation
APIPay Ops endpointsBoarding

Search people

Beta
View as MarkdownOpen in Claude

Searches for people by identity attributes during boarding. The search covers every business in your organization, so use it to find a person before you create them again. To read the people already on a paypoint’s business, use a standard GET instead. Provide at least one of firstName or lastName. Each result has a matchScore showing how closely it matches, and an external identity vendor can enrich the results. Each result’s dateOfBirth is masked. To get the full value, use the unmasked search.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entrystringRequired

The entry name of your organization, from OrgEntryName on the organization. With a paypoint’s entry name instead, the search covers only that paypoint’s business.

orgIdlongRequired
The ID of your organization.

Request

This endpoint expects any.
anyRequired
OR
anyRequired

Response

The search results.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null
The search results.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error