Get started
api reference
GET
/v1/verifications/{verification_id}

Path Parameters

verification_id*Verification Id
Formatuuid

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/verifications/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "country_code": "string",  "number_type": "string",  "subject_type": "string",  "subject_name": "string",  "purpose": "string",  "state": "string",  "rejection_reason": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "submitted_at": "2019-08-24T14:15:22Z",  "approved_at": "2019-08-24T14:15:22Z",  "confirmation": "string",  "step": "confirm_identity",  "campaign_accepted": false,  "runtime_ready": true,  "cancellable": false,  "identity_confirmed": false,  "waiting_for_credit": false,  "credit_needed_cents": 0}

Get Requirements

What the carrier needs from you: the fields, the documents, and whether an address is needed. `purpose=number` (default) is for buying a number; it requires the offer's `quote_id` (422 without it) and returns the form for that offer. `purpose=sms` is for registering to send SMS in the US; it uses the carrier of your US numbers, or of the number passed as `number_id`. Build your form from it. `provider` is ignored.

Get Whoami

Identify the caller: auth kind, organization, and (if resolvable) user. Useful for an agent that needs the human's address to put in Reply-To, since the bearer token itself only carries an organization. user_id/email/name come back null for a shared-key (HAIL_API_KEY) call, which has no individual user behind it.