Query Parameters
2 <= length <= 2Who is verifying: 'person' (you) or 'business' (your company). Required. Ask the user which one.
Value in
- "person"
- "business"
Deprecated and ignored. Hail picks the carrier from quote_id or number_id.
"number"Required for purpose=number: quote_id of an offer from POST /numbers/quotes that needs verification. The carrier is read from it.
For purpose=sms: id of one of your US numbers. The carrier is read from it. Needed when your US numbers are with more than one carrier.
Header Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/verifications/requirements?country_code=st&number_type=string&subject_type=person"{ "country_code": "string", "number_type": "string", "subject_type": "person", "required": true, "fields": [], "documents": [], "address_required": false, "subject_types": []}Get Verification Application
Read your organization's saved SMS answers, including after rejection. Answers of a cancelled or rejected registration are kept for 30 days after it ended; after that this returns 404. Older applications may recover their verified sender identity through read-only provider calls; a 404 asks for original details and support when these cannot be recovered. The ordinary list never contains application fields or addresses. No records are filed or charged here.
Get Verification
One verification of your organization. Once submitted, its state is updated from the carrier each time you read it.