Skip to navigation

Address lookup report submitted

Webhook for the report/address-lookup.submitted event. For more info see Webhooks Overview.

Sent when an address lookup report has been submitted to its upstream data source and is awaiting results (status is submitted). A ready or errored event follows once processing completes.

The payload is the polymorphic report object. Inspect payload.data.type (report/address-lookup) to identify the report, and payload.data.attributes for its inputs and results.

Headers

Persona-SignaturestringOptional

Header. An HMAC that you should use to check that requests are authentic. Compare this value with your own digest, computed from the request body and your webhook secret. For more info see Webhook Best Practices.

Persona-Webhook-Attempts-MadeintegerOptional
The number of times that Persona has attempted to deliver this webhook. This value is incremented each time Persona attempts to deliver the webhook, regardless of whether the delivery was successful.
Persona-Webhook-Attempts-LeftintegerOptional
The number of times that Persona will attempt to deliver this webhook. This value is decremented each time Persona attempts to deliver the webhook.
Persona-Webhook-First-Attempted-AtintegerOptional
The time at which Persona first attempted to deliver this webhook. This value is a Unix timestamp in seconds.

Payload

The payload of this webhook request is an object.
dataobjectOptional

Response

200

Return a 2xx status code to indicate that the data was received successfully. Any other status will trigger retries. For more info see Retry Logic.