Search people (unmasked)

Beta

POST

/v2/people/search/unmasked

POST

/api/v2/people/search/unmasked

curl -X POST "https://api-sandbox.payabli.com/api/v2/people/search/unmasked?entry=8cfec329267&orgId=123" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "firstName": "Marcus",
  "lastName": "Delgado"
}'

{
  "success": true,
  "message": "People search completed",
  "traceId": "0HNP99BPE1LNM:00000060",
  "data": {
    "results": [
      {
        "personReference": "01a0014d-ce1a-7110-9bac-c4c59647a88d",
        "firstName": "Marcus",
        "lastName": "Delgado",
        "dateOfBirth": "1985-03-14",
        "primaryEmail": "marcus.delgado@example.com",
        "primaryPhone": "+13055551212",
        "riskDecision": null,
        "matchScore": 0.6,
        "isTopMatch": true,
        "isFromVendor": false,
        "phones": [
          "+13055551212"
        ],
        "emails": [
          "marcus.delgado@example.com"
        ],
        "addressCount": 0,
        "phoneCount": 1,
        "emailCount": 1
      }
    ],
    "total": 1,
    "isEnrichedByVendor": false
  }
}

Searches for people by identity attributes during boarding, and returns each result’s dateOfBirth unmasked. The query parameters, request body, and other response fields match the standard people search. Provide at least one of firstName or lastName.

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

Response

The search results, with dateOfBirth unmasked.

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