Sign inGet Started

Get a submission

GET
/v1/compliance/submissions/{submission_id}
const submission = await bird.complianceSubmissions.get(
  "csb_01krdgeqcxet5s7t44vh8rt9mg",
);
for (const item of submission.items ?? []) {
  console.log(item.key, item.state, item.reason ?? "");
}
Reactie200
{
  "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"
      ]
    }
  ]
}

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.

Parameters

submission_idstring

Submission ID.

Response Payload

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.

Onderliggende attributen tonen
id
string
verplicht
subject_kind
string
verplicht
subject_id
string
verplicht
program
string
verplicht
country_code
string
verplicht
identity_id
nullable string
verplicht

The party this registration was filed for, or null if none was named.

satisfied
boolean
verplicht

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
verplicht

Every answer and where it stands. Each is decided on its own.

Onderliggende attributen tonen
created_at
string
verplicht

When this was submitted.

updated_at
string
verplicht

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.

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.