Verification

Start a list check

Checks the addresses of a quote. The list comes from the quote, so it cannot change after the user said yes. approved_maximum_charge is the most the user agreed to pay; the check never costs more. Half a credit per fresh check, rounded up per run. Starting the same quote again returns the same run.

CostWhat it doesKey scopes
0.5 credit per address that needs a fresh check, never more than approved_maximum_chargeSpends creditsargorant:verify_emails
post/api/v1/verifications

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/verifications
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

quote_idstring required

The quote the user agreed to.

approved_maximum_chargeinteger required

The most the user agreed to pay, in credits (0 to 1,000).

Example request

{
  "quote_id": "4b1d2c3e4f5a6b7c8d9e0f1a2b3c4d5e",
  "approved_maximum_charge": 1
}

Response

Started

run_idstring

Run id.

totalinteger

Addresses in the run.

doneinteger

Addresses checked so far.

completeboolean

true when every address is checked.

credits_chargedinteger

Credits charged.

checks_chargedinteger

Fresh checks charged.

results_urlstring uri

Where the full results are in the app.

Changes

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