Find Person

Permute and verify email candidates for a person at a domain.

POST/api/v1/finder/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/finder/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: FIND_PERSON" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string",
    "first_name": "Jordan",
    "last_name": "Lee",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }'

Authorization

Minimum role: Sales repThe caller must hold this role or a higher one.
Action: FIND_PERSON

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be FIND_PERSON for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

domainstringRequired
No description yet.
minimum length 1
first_namestringRequired
No description yet.
minimum length 1
last_namestringRequired
No description yet.
minimum length 1
tenant_iduuidRequired
No description yet.
policyobjectOptional
Optional collection controls. Defaults preserve discovery results while quarantining catch-all addresses from promotion.
Default
{"catchAllPolicy":"quarantine","confidenceThreshold":null,"excludeGenerics":false,"smtpStrict":false}
4 child fields
- catchAllPolicyenumOptional
  How a Finder collection treats catch-all addresses.
  Allowed values
  quarantine
  allow
  reject
  Default
  quarantine
- confidenceThresholdnumber or nullOptional
  Fraction in 0..=1; metadata choices 80/90/95 represent percentages.
- excludeGenericsbooleanOptional
  No description yet.
  Default
  false
- smtpStrictbooleanOptional
  No description yet.
  Default
  false

Response

Status 202. The command was applied. The body is the record as it stands after the command: a JSON object whose fields depend on the record.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send FIND_PERSON.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below rep or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.