Instasent · Schema

ResponseRegistrationChecklist

One country's registration for one sender: what its paperwork asks of the customer, and how far along it is.

CompanyMessagingSMSRCSWhatsAppArtificial IntelligenceMarketing

Properties

Name Type Description
country string ISO 3166-1 alpha-2.
channel string
available boolean False means the country requirements could not be read. It is NOT the same as the country asking for nothing, and must never be presented as "nothing left to do".
steps array
register object The register's own identity. On RCS this carries the `externalAgentId` that several operators ask the customer to quote verbatim in the paperwork they send; it is null until the agent has been filed.
View JSON Schema on GitHub

JSON Schema

instasent-response-registration-checklist-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/instasent/json-schema/instasent-response-registration-checklist-schema.json",
  "title": "ResponseRegistrationChecklist",
  "description": "One country's registration for one sender: what its paperwork asks\nof the customer, and how far along it is.\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/instasent-registration-api-openapi.yml#/components/schemas/ResponseRegistrationChecklist",
  "type": "object",
  "properties": {
    "country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2."
    },
    "channel": {
      "type": "string",
      "enum": [
        "sms",
        "rcs"
      ]
    },
    "available": {
      "type": "boolean",
      "description": "False means the country requirements could not be read. It is\nNOT the same as the country asking for nothing, and must never\nbe presented as \"nothing left to do\".\n"
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ResponseRegistrationStep"
      }
    },
    "register": {
      "type": "object",
      "description": "The register's own identity. On RCS this carries the\n`externalAgentId` that several operators ask the customer to\nquote verbatim in the paperwork they send; it is null until\nthe agent has been filed.\n",
      "additionalProperties": {
        "type": [
          "string",
          "null"
        ]
      }
    }
  },
  "required": [
    "country",
    "channel",
    "steps",
    "available"
  ],
  "$defs": {
    "ResponseRegistrationStep": {
      "type": "object",
      "description": "One step of a country's registration. Three states, of which only\none is stored: `completed` is recorded, `disabled` is derived from\nthe dependency graph, and neither means the step can be acted on now.\n",
      "properties": {
        "key": {
          "type": "string",
          "description": "Stable forever, and the identity progress is recorded against.\nReused across countries when it is the same concept. Show the\ntitle to a person, never this. `payment` is reserved for the\npayment row.\n"
        },
        "kind": {
          "type": "string",
          "enum": [
            "payment"
          ],
          "description": "Present only on the payment row, the register's payment for\nthe registration, always the last row. Absent on every\npaperwork step.\n"
        },
        "title": {
          "type": "string"
        },
        "actor": {
          "type": "string",
          "enum": [
            "customer",
            "instasent",
            "third-party"
          ],
          "description": "Whose step it is."
        },
        "completed": {
          "type": "boolean"
        },
        "disabled": {
          "type": "boolean",
          "description": "An earlier step it depends on is not done. Do not offer it as\nan action: it is not \"pending on the customer\", it is not\nstartable.\n"
        },
        "isBlocker": {
          "type": "boolean",
          "description": "True on every paperwork step: a country's paperwork is not\noptional. False on the payment row, which never holds the\nregistration back.\n"
        },
        "skipped": {
          "type": "boolean"
        },
        "skippable": {
          "type": "boolean",
          "description": "Always false. These cannot be dismissed."
        },
        "waitingOn": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "customer",
            "instasent",
            "third-party",
            "submission",
            null
          ],
          "description": "Whose move it is right now: this step's actor once it is\nstartable, otherwise the actor of whatever is blocking it.\n`submission` means the registration has not been submitted\nyet. Null only on the payment row once nothing is owed.\n"
        },
        "completedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "When it was done. On the payment row, when the payment was\nexecuted, and null while it is not.\n"
        },
        "payment": {
          "type": "object",
          "description": "Only on the payment row: the payment, the same summary the\nregister serves as `relatedChargeRequest`. `amount` is before\ntaxes and `finalAmount` with them. `publicReference` is null\non a wire-transfer draft that has not got one yet.\n`paymentLink` is null when the payment has no link, and\n`active: false` once it can no longer be paid.\n",
          "properties": {
            "id": {
              "type": "string"
            },
            "publicReference": {
              "type": [
                "string",
                "null"
              ]
            },
            "status": {
              "type": "string",
              "description": "The payment status: executed means paid."
            },
            "chargeTitle": {
              "type": "string"
            },
            "amount": {
              "type": [
                "number",
                "null"
              ]
            },
            "finalAmount": {
              "type": "number"
            },
            "currency": {
              "type": "string"
            },
            "paymentLink": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "url": {
                  "type": "string"
                },
                "active": {
                  "type": "boolean"
                }
              }
            },
            "createdAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "executedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            }
          }
        },
        "customerCanMark": {
          "type": "boolean",
          "description": "Whether the customer may tick this one themselves. True only\nfor their own steps; the backend refuses the rest regardless\nof what a screen offers.\n"
        }
      },
      "required": [
        "key",
        "title",
        "actor",
        "completed",
        "disabled"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/instasent-response-registration-checklist"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.