Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Update compliance answers

POST
/v1/compliance/submissions/{submission_id}/resupply
const submission = await bird.complianceSubmissions.resupply(
  "csb_01krdgeqcxet5s7t44vh8rt9mg",
  {
    answers: [{ key: "business_registration_number", value: "90012769" }],
  },
);
console.log(submission.satisfied);
Response200
{
  "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"
      ]
    }
  ]
}

Replaces rejected, expired, or missing answers on an existing submission. Accepted answers normally cannot be changed and should be omitted.

When a verifier requests corrections, you can replace selected accepted answers while that correction remains open and before its deadline. Unchanged entries are ignored, and at least one answer must change. Changed answers are reviewed again; other answers remain unchanged.

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.

Parameters

submission_idstring

Submission ID.

Request Payload

answers
array
required
Show child parameters

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.

Show child attributes
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.

Show child attributes
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

Continue with the documentation, guides and examples for this topic.

Get an implementation brief