hail.sodocs
GET
/v1/verifications/requirements

Query Parameters

country_code*Country Code
Length2 <= length <= 2
number_type*Number Type
subject_type?Subject Type
Default"person"

Value in

  • "person"
  • "business"
provider?string|null

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/verifications/requirements?country_code=st&number_type=string"
{  "provider": "string",  "country_code": "string",  "number_type": "string",  "subject_type": "person",  "required": true,  "fields": [],  "documents": [],  "address_required": false,  "subject_types": []}

Get Subscription

Fetch one webhook subscription by id. The signing secret is omitted.

Get Verification

One verification of your organization. Once submitted, its state is updated from the carrier each time you read it.