Sign in
Identity Append (USA only)

Submit an individual's name, postal address, and/or email to append the individual's relevant contact information or email risk score.

post/identity/append/v1

Headers

Reference-Idstring

Optional identifier that will be returned in the response to help you track the request.

Timeout-Secondsinteger

Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.

Add-Metadataboolean

Specify whether the response should return all fields and values, in addition to the main core information.

Request body

attributesstring[] required

Type of the request.

Example request

{
  "components": {
    "first_name": [
      "John"
    ],
    "middle_name": [
      "Abraham"
    ],
    "last_name": [
      "Smith"
    ],
    "address_line_1": [
      "1 Main Street"
    ],
    "town": [
      "Phoenix"
    ],
    "sub_region": [
      "Yancey"
    ],
    "region": [
      "AZ"
    ],
    "postal_code": [
      "94133"
    ],
    "email": [
      "John.A.Smith@example.com"
    ],
    "phone": [
      "1234567890"
    ],
    "country_iso_2": [
      "US"
    ],
    "ip_address": [
      "255.255.255.255"
    ],
    "user_agent": [
      "python-requests/2.27.1"
    ]
  },
  "options": [
    {
      "name": "dnc_preference",
      "value": "flag | exclude | only"
    }
  ],
  "attributes": [
    "email"
  ]
}

Response

OK

Example response

{
  "error": {
    "title": "Bad Request",
    "detail": "The request body was malformed."
  },
  "result": {
    "email": "John.A.Smith@example.com",
    "contacts": [
      {
        "first_name": "John",
        "last_name": "Smith",
        "address_line_1": "1 Main Street",
        "town": "Phoenix",
        "region": "AZ",
        "postal_code": "94133",
        "country_iso_3": "USA"
      }
    ]
  },
  "metadata": {
    "email_detail": {
      "email_type": "individual",
      "date_first_seen": "2016-08-09",
      "domain": {
        "date_first_seen": "now",
        "domain_type": "freeisp"
      },
      "confidence": "verified",
      "verbose_output": "verified",
      "verbose_reason": "Valid email address."
    },
    "address_detail": {
      "first_name_match": "match",
      "last_name_match": "no_match",
      "address_line_1_match": "no_data",
      "town_match": "no_data",
      "postal_code_match": "no_data",
      "deliverability": "undeliverable",
      "deliverability_detail": "missing_primary",
      "address_type": {
        "code": "S",
        "description": "Street"
      }
    },
    "ip_detail": {
      "routing_type": "fixed",
      "organization": "experian",
      "proxy_type": "tor"
    },
    "phone_detail": [
      {
        "phone_type": "mobile",
        "number": "123-456-7890",
        "dnc_date_revised": "2023-08-31"
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.