---
title: "Get a submission"
canonical: "https://bird.com/docs/api/reference/get-workspace-compliance-submission"
---

# Get a submission

`GET /v1/compliance/submissions/{submission_id}`

Returns every answer on a submission and where each one stands. Each is decided on its own, so
some can be accepted while others are still under review or need replacing, and a rejected
answer carries the reason it was refused.

## Code samples

**TypeScript**

```ts
const submission = await bird.complianceSubmissions.get(
  "csb_01krdgeqcxet5s7t44vh8rt9mg",
);
for (const item of submission.items ?? []) {
  console.log(item.key, item.state, item.reason ?? "");
}
```

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

## Example response `200`

```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"
      ]
    }
  ]
}
```

## Path parameters

- `submission_id` (string): Submission ID.

## 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)