---
title: "POST /api/leads/lookup"
method: POST
path: "/api/leads/lookup"
tags: ["Lead"]
---

# POST /api/leads/lookup

`POST /api/leads/lookup`

## Request

- Base URL: `https://data.deluxe.com` (the document declares no server; this is the origin it was published from)
- URL: `https://data.deluxe.com/api/leads/lookup`
- Auth: API key in header `X-Deluxe-Auth`
- TypeScript: <https://skmtc.dev/deluxe/apis/append-api/docs/api/leads/lookup/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- AppendRequest
  - `firstName` string, nullable
  - `lastName` string, nullable
  - `address1` string, nullable
  - `address2` string, nullable
  - `city` string, nullable
  - `state` string, nullable
  - `zip` string, nullable
  - `mart` string, nullable
  - `attributes` string[], nullable
  - `suppliers` string[], nullable
  - `criteria` object, nullable

## Response `200`

Success

- AppendResult
  - `transactionId` string, nullable
  - `matchType` 0 | 1 | 2
  - `recordFound` boolean
  - `status` string, nullable
  - `attributes` object, nullable

---

[API](https://skmtc.dev/deluxe/apis/append-api.md) - [All operations](https://skmtc.dev/deluxe/apis/append-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deluxe/apis/append-api/revisions/e7cde4e5a902?raw)
