Search users

post/users/search

Search users by fingerprinted vault data or external ID. Some pieces of vault data are automatically fingerprinted for search here. Searchable fields include id.phone_number, id.email, id.ssn9, id.drivers_license_number, id.us_tax_id, id.itin, and the bank account numbers bank.*.ach_account_number, bank.*.ach_account_id, and bank.*.iban.

Request

Body

external_id·

optional string

Return only the user with this external_id.

pagination·

optional object

cursor·

optional integer

page_size·

optional integer

search·

optional string

PII search query. Returns users that have matching PII.

Response

data·

array of objects

external_id·

optional string

id·

string

sandbox_id·

optional string

Only populated for users created in sandbox mode.

meta·

object

POST /users/search

1curl -X POST https://api.onefootprint.com/users/search \
2  -u sk_test_xxxxx: \
3  -d '{
4    "external_id": "0cece047-151f-4ac4-9782-dc27691fd766",
5    "pagination": {
6      "page_size": 10
7    },
8    "search": "sandbox@onefootprint.com"
9  }'

Response example

{
  "data": [
    {
      "external_id": "0cece047-151f-4ac4-9782-dc27691fd766",
      "id": "fp_id_7p793EF07xKXHqAeg5VGPj",
      "sandbox_id": "WH8RkRCDSxCfH"
    },
    {
      "external_id": "0cece047-151f-4ac4-9782-dc27691fd766",
      "id": "fp_id_7p793EF07xKXHqAeg5VGPj",
      "sandbox_id": "WH8RkRCDSxCfH"
    }
  ],
  "meta": {
    "count": 10000,
    "next": 1
  }
}