---
title: "Create a registration submission"
canonical: "https://bird.com/docs/api/reference/create-workspace-compliance-submission"
---

# Create a registration submission

`POST /v1/compliance/submissions`

Submits every answer at once. Because submissions have no multi-call draft, send a complete
set; anything missing or malformed comes back named field by field.

Each answer is then reviewed on its own. Submitting again for a registration that already has
one returns a 409. Use `POST /v1/compliance/submissions/{submission_id}/resupply` to replace
rejected, expired, or missing answers, and read the submission ID from the requirements for
that registration. Accepted answers normally cannot be changed. During an open verifier
correction and before its deadline, you can replace selected accepted answers. Unchanged entries are ignored; at least
one answer must change. Other answers remain unchanged. A closed number or SMS sender submission must be
reopened by Bird before you can submit an updated form.

An `identity` submission registers your business itself. Its subject is the party: send the
`cid_` id of a party your workspace holds as `subject_id`, with `program` `business` and
`country_code` `ZZ`, the international coordinate: your business registers once, not per
country. When `subject_kind` is `identity`, send neither `identity_id` nor `identity`,
because the subject already names the party.

The answers are a legal representation under the name of the business they describe. Accepted
dossiers can be registered with the carrier or regulator after compliance review.
For SMS sender registrations with an unpaid setup fee, your wallet must cover
setup and the first recurring charge. This submission charges the setup fee;
insufficient funds return `402`.

## Code samples

**TypeScript**

```ts
const submission = await bird.complianceSubmissions.create({
  subject_kind: "number",
  subject_id: "nda_01krdgeqcxet5s7t44vh8rt9mg",
  program: "local",
  country_code: "US",
  answers: [
    { key: "legal_entity_name", value: "Goldcrest Communications Inc" },
    { key: "business_registration_number", value: "90012768" },
  ],
});
// There is no draft: the answers are filed for review as of this call.
console.log(submission.id, submission.satisfied);
```

Examples: [TypeScript](/docs/api/reference/create-workspace-compliance-submission.ts.md) · [Python](/docs/api/reference/create-workspace-compliance-submission.py.md) · [Go](/docs/api/reference/create-workspace-compliance-submission.go.md) · [PHP](/docs/api/reference/create-workspace-compliance-submission.php.md) · [CLI](/docs/api/reference/create-workspace-compliance-submission.cli.md) · [MCP](/docs/api/reference/create-workspace-compliance-submission.mcp.md) · [cURL](/docs/api/reference/create-workspace-compliance-submission.curl.md)

## Example response `201`

```json
{
  "next": [
    {
      "kind": "operation"
    }
  ],
  "id": "csb_01krdgeqcxet5s7t44vh8rt9mg",
  "subject_kind": "sms_sender",
  "subject_id": "scr_01krdgeqcxet5s7t44vh8rt9mg",
  "program": "alpha",
  "country_code": "US",
  "identity_id": "cid_01krdgeqcxet5s7t44vh8rt9mg",
  "items": [
    {
      "id": "cit_01krdgeqcxet5s7t44vh8rt9mg",
      "state": "not_supplied",
      "attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
      "attachment_ids": [
        "tca_01krdgeqcxet5s7t44vh8rt9mg"
      ]
    }
  ]
}
```

## Request body

- `subject_kind` (string, required)

  What is being registered.

  - `sms_sender`: a sender registered to send to one country.
  - `number`: a phone number you hold that needs ownership paperwork before it
    can carry traffic.
  - `identity`: a business you operate as, registered once and reused by
    later registrations that name it.

  Possible values: `sms_sender`, `number`, `identity`
- `subject_id` (string, required): What is being registered. For `sms_sender` this is the `scr_` id returned when you register a sender for a country. For `number` it is the `nda_` id of a dedicated number you hold, as returned by `GET /v1/numbers`. A shared short code (`nal_`) is not accepted: it is shared, so its ownership paperwork is not yours to file. For `identity` it is the `cid_` id of the party being registered, picked from the parties your workspace holds, as returned by `GET /v1/compliance/identities`.
- `program` (string, required)

  The registration program a country runs. Available programs depend on the registered resource. An SMS sender registers under an authority regime (`alpha` or `numeric`). A phone number proves ownership under its number type (`mobile`, `local`, `national`, `short_code`, `short_code_fteu`, or `toll_free`), matching the values of `NumberType`. An identity registers your business itself under `business`, internationally: its coordinate's country is always `ZZ`. A value is therefore only meaningful alongside the subject it describes. More are added as coverage grows, so treat this as an open set rather than a fixed list.

  Possible values (may grow over time): `alpha`, `numeric`, `mobile`, `local`, `national`, `short_code`, `short_code_fteu`, `toll_free`, `business`
- `country_code` (string, required): ISO 3166-1 alpha-2 country code.
- `identity_id` (string): An existing party this registration is for. It fills in the business details you left out from what that party already holds, and each single-value answer you file about the party is written back onto it for next time, whatever the verdict. Documents and multi-value answers are asked fresh each time. Send this or `identity`, never both. An id belonging to another organization is rejected; nothing is created here. When `subject_kind` is `identity`, send neither: `subject_id` already names the party.
- `identity` (object)

  Registers this on behalf of a party you have not stored yet, creating it as part
  of the submission so you do not need a separate call. Exclusive with
  `identity_id`.

  Each time you send this you get a new party. Single-value identity answers filed for one
  are reused by registrations naming the same party. Documents and lists are
  supplied separately for each registration. Send this once and use the
  `identity_id` from the response for the countries that follow.
- `identity.name` (string): What to call the party. Optional: left out, it takes the legal entity name you supplied. If this country's form does not ask for one, send a name here.
- `answers` (array, required): Every answer at once. Because submissions have no multi-call draft, send a complete set. Anything missing or malformed comes back named. A requirement the named party already answers may be left out; one you send anyway wins over what the party holds.
- `answers.key` (string, required): The requirement this answers, as given by its key in the requirements read.
  - Variant `value`
    - `answers.value` (string, required): The answer, for a requirement answered inline. Send every answer as a string whatever its data type, so a number goes as `"1500"` and a yes-or-no as `"true"`.
  - Variant `attachment_id`
    - `answers.attachment_id` (string, required): The uploaded document, for a requirement that takes one. Upload the file as an attachment first, then send the id it returns.
  - Variant `values`
    - `answers.values` (array of string, required): The answers, for a requirement whose `max_items` is set and which is answered inline. Send each as a string whatever its data type, and send them in the order you mean them to be read. At most `max_items` of them.
  - Variant `attachment_ids`
    - `answers.attachment_ids` (array of string, required): The uploaded documents, for a requirement whose `max_items` is set and which takes documents. Upload each file first and send the ids it returns, in order. At most `max_items` of them.

## Response body

- `next` (array of object)

  What to do next about this submission, given the state it is in. Each entry names one action and says
  why it is worth taking, so you can act on this response without working out the order
  yourself. Present on reads that compute it: an empty list means there is nothing to do,
  and the field is absent entirely on responses that do not report next actions.

  A submission reports the answers you filed; whether the country's requirements are met is
  reported by the requirements read. So this points there rather than repeating a verdict it
  does not own.
- `next.kind` (string, required)

  What you do about this step.

  - `operation`: call the operation named in `operation`, then
    read again.
  - `external`: act somewhere this API does not reach, then read
    again.
  - `wait`: nothing is asked of you, so read again later.
  - `terminal`: nothing you do resolves this, so stop retrying.

  Tolerate a value you do not recognize: show the `description` and
  offer no action.

  Possible values (may grow over time): `operation`, `external`, `wait`, `terminal`
- `next.description` (string, required): A short, human-readable label for the step, suitable for display.
- `next.operation` (string): The operationId to call. Present only when `kind` is `operation`. The operation's own schema says how to call it; this says only which one, and what to address it with.
- `next.params` (object): The parameters that address the operation, by name: `{"sender_id": "…"}` for an operation on `/v1/sms/senders/{sender_id}/requirements`. A parameter the operation takes in its query string is given the same way, so an operation addressed as `?subject_id=` carries `{"subject_id": "…"}`. Every parameter the call needs is here, whether its value came from the thing you were acting on or is fixed for this step, so you can make the call from this object alone. Present only when `kind` is `operation` and the operation names a subject. A request body, when the operation takes one, is described by the operation's own schema and never appears here.
- `next.url` (string): A URL to open. Present only when `kind` is `external`, and only when the step has one. An external step whose `description` says to go and do something with no URL to open is normal.
- `id` (string, required)
- `subject_kind` (string, required)
- `subject_id` (string, required)
- `program` (string, required)
- `country_code` (string, required)
- `identity_id` (nullable string, required): The party this registration was filed for, or `null` if none was named.
- `satisfied` (boolean, required): Whether this country's requirements are met. `true` once the submission is approved and every required requirement is approved or marked not applicable. This can remain true when an external verifier requests a correction. Once you submit that correction, it must pass review before this becomes true again, including any optional answers you change.
- `items` (array of object, required): Every answer and where it stands. Each is decided on its own.
- `items.inherited` (boolean, required): `true` when this answer was accepted without a fresh review, because the same answer to the same requirement had already been approved for this party in this country. It carries the original verdict, including when that verdict expires.
- `items.id` (string, required)
- `items.key` (string, required): The requirement this answers.
- `items.state` (string, required)
- `items.value` (nullable string, required): Your answer, for a requirement answered inline. Every answer travels as a string whatever its data type, so a number reads back as `"1500"` and a yes-or-no as `"true"`. Use the data type to parse it. `null` for a requirement that takes a document.
- `items.attachment_id` (nullable string, required): The document you supplied, for a requirement that takes one. `null` otherwise.
- `items.values` (nullable array, required): Your answers, for a requirement that takes several and is answered inline. `null` for one answered once. Order is as you sent it.
- `items.attachment_ids` (nullable array, required): The documents you supplied, for a requirement that takes several. `null` otherwise.
- `items.reason` (nullable string, required): Why this was rejected, when it was. `null` otherwise.
- `items.decided_at` (nullable string, required): When this was decided. `null` while no decision has been made.
- `items.expires_at` (nullable string, required): When this answer goes stale and must be supplied again. `null` when it does not expire.
- `created_at` (string, required): When this was submitted.
- `updated_at` (string, required): When it last changed.
- `closed_at` (nullable string): When this submission was closed. Null while it remains open.
- `closure_reason` (nullable string): The decline reason for a closed submission, or null while open.

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)