What a business verification needs

GEThttps://api.norreach.app/v1/number-verifications/requirements

What numbers of a country and number_type ask for before they can be bought: each field (text, address or document) with its id, label, description, example and criteria, read live. required: false = nothing is needed. Also the workspace's own verification for it, if there is one.

numbers:readOperation id: get_number_verification_requirements

GET/number-verifications/requirements

curl -X GET "https://api.norreach.app/v1/number-verifications/requirements" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

What a business verification needs

{
  "object": "verification_requirements",
  "country": "SE",
  "number_type": "local",
  "configured": true,
  "required": true,
  "fields": [
    {
      "id": "req-company-number",
      "kind": "text",
      "label": "Company registration number",
      "description": "The company's registration number.",
      "example": "556677-8899",
      "criteria": [
        "10–11 characters"
      ],
      "input": {
        "type": "text",
        "min_length": 10,
        "max_length": 11,
        "options": [],
        "characters": "0123456789-"
      },
      "file": null
    },
    {
      "id": "req-proof",
      "kind": "document",
      "label": "Proof of address",
      "description": "A utility bill showing the address.",
      "example": null,
      "criteria": [
        "Less than 3 months old"
      ],
      "input": null,
      "file": {
        "accept": ".pdf,.jpg,.jpeg,.png",
        "max_bytes": 4000000
      }
    }
  ],
  "verification": null,
  "limits": {
    "max_upload_bytes": 4000000,
    "document_types": [
      "application/pdf",
      "image/jpeg",
      "image/png"
    ]
  }
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope numbers:read. API keys and scopes

Query parameters

countrystringqueryrequired

number_typeenumquery

One of:localmobiletoll_freenationalshared_cost

Response

200application/json— What a business verification needs

object"verification_requirements"required

countrystringrequired

number_typeenumrequired

One of:localmobiletoll_freenationalshared_cost

configuredbooleanrequired

False while business verification isn't available on this workspace.

requiredbooleanrequired

False = numbers of this country and type need no verification.

fieldsobject[]required

Show child attributes

fields[].idstringrequired

Send the value under this id.

fields[].kindenumrequired

One of:textaddressdocument

fields[].labelstringrequired

fields[].descriptionstringrequired

fields[].examplestring | nullrequired

fields[].criteriastring[]required

fields[].inputobject | nullrequired

fields[].fileobject | nullrequired

verificationobject | nullrequired

The workspace's own verification for this country and type, if any.

limitsobjectrequired

Show child attributes

limits.max_upload_bytesintegerrequired

limits.document_typesstring[]required

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
422	`validation_failed`	The request has invalid fields.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/number-verifications/requirements

curl -X GET "https://api.norreach.app/v1/number-verifications/requirements" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

What a business verification needs

{
  "object": "verification_requirements",
  "country": "SE",
  "number_type": "local",
  "configured": true,
  "required": true,
  "fields": [
    {
      "id": "req-company-number",
      "kind": "text",
      "label": "Company registration number",
      "description": "The company's registration number.",
      "example": "556677-8899",
      "criteria": [
        "10–11 characters"
      ],
      "input": {
        "type": "text",
        "min_length": 10,
        "max_length": 11,
        "options": [],
        "characters": "0123456789-"
      },
      "file": null
    },
    {
      "id": "req-proof",
      "kind": "document",
      "label": "Proof of address",
      "description": "A utility bill showing the address.",
      "example": null,
      "criteria": [
        "Less than 3 months old"
      ],
      "input": null,
      "file": {
        "accept": ".pdf,.jpg,.jpeg,.png",
        "max_bytes": 4000000
      }
    }
  ],
  "verification": null,
  "limits": {
    "max_upload_bytes": 4000000,
    "document_types": [
      "application/pdf",
      "image/jpeg",
      "image/png"
    ]
  }
}