Sign in

v1

latestOpenAPI 3.0.32026-08-061610559.1 KB

Search using demographic information (demographicsSearch)

Searches Verato using the provided demographic and provider attributes. It returns zero or more candidate identities ordered by match score.

post/demographicsSearch

Request body

trackingIdstring

Example request

{
  "content": {
    "identity": {
      "contactInformation": [
        {
          "address": {
            "line1": "123 Main St",
            "city": "Springfield",
            "state": "VA",
            "postalCode": "22150"
          },
          "phoneList": [
            {
              "number": "5551234567",
              "type": "WORK",
              "bestTimeToContact": {
                "day": "MON",
                "startTime": "09:00",
                "endTime": "17:00",
                "allDay": false
              }
            }
          ],
          "bestTimeToContact": {
            "day": "MON",
            "startTime": "09:00",
            "endTime": "17:00",
            "allDay": false
          }
        }
      ],
      "phoneNumbers": [
        {
          "number": "5551234567",
          "type": "WORK",
          "validFrom": "2024-01-01",
          "validTo": "2024-12-31",
          "bestTimeToContact": {
            "day": "MON",
            "startTime": "09:00",
            "endTime": "17:00",
            "allDay": false
          }
        }
      ]
    }
  }
}

Response

Successful demographics search operation.

auditIdstring
successboolean
warningsstring[]
retryableErrorboolean
messagestring
errorsstring[]
trackingIdstring

Example response

{
  "content": {
    "searchResults": [
      {
        "identity": {
          "contactInformation": [
            {
              "address": {
                "line1": "123 Main St",
                "city": "Springfield",
                "state": "VA",
                "postalCode": "22150"
              },
              "phoneList": [
                {
                  "number": "5551234567",
                  "type": "WORK",
                  "bestTimeToContact": {
                    "day": "MON",
                    "startTime": "09:00",
                    "endTime": "17:00",
                    "allDay": false
                  }
                }
              ],
              "bestTimeToContact": {
                "day": "MON",
                "startTime": "09:00",
                "endTime": "17:00",
                "allDay": false
              }
            }
          ],
          "phoneNumbers": [
            {
              "number": "5551234567",
              "type": "WORK",
              "validFrom": "2024-01-01",
              "validTo": "2024-12-31",
              "bestTimeToContact": {
                "day": "MON",
                "startTime": "09:00",
                "endTime": "17:00",
                "allDay": false
              }
            }
          ]
        }
      }
    ]
  }
}