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 ?? "");
}
प्रतिक्रिया200
{
  "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.

पैरामीटर

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.

चाइल्ड एट्रिब्यूट दिखाएँ
id
string
आवश्यक
subject_kind
string
आवश्यक
subject_id
string
आवश्यक
program
string
आवश्यक
country_code
string
आवश्यक
identity_id
nullable string
आवश्यक

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

satisfied
boolean
आवश्यक

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
आवश्यक

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

चाइल्ड एट्रिब्यूट दिखाएँ
items.inherited
boolean
आवश्यक

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
आवश्यक
items.key
string
आवश्यक

The requirement this answers.

items.state
string
आवश्यक
items.value
nullable string
आवश्यक

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
आवश्यक

The document you supplied, for a requirement that takes one. null otherwise.

items.values
nullable array
आवश्यक

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
आवश्यक

The documents you supplied, for a requirement that takes several. null otherwise.

items.reason
nullable string
आवश्यक

Why this was rejected, when it was. null otherwise.

items.decided_at
nullable string
आवश्यक

When this was decided. null while no decision has been made.

items.expires_at
nullable string
आवश्यक

When this answer goes stale and must be supplied again. null when it does not expire.

created_at
string
आवश्यक

When this was submitted.

updated_at
string
आवश्यक

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.

इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।