Sign inGet Started

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);
Réponse200
{
  "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.

Paramètres

submission_idstring

Submission ID.

Corps de la requête

answers
array
obligatoire
Afficher les paramètres enfants
answers.key
string
obligatoire

The requirement this answers, as given by its key in the requirements read.

answers.value
string
obligatoire

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".

Contenu de la réponse

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.

Afficher les attributs enfants
id
string
obligatoire
subject_kind
string
obligatoire
subject_id
string
obligatoire
program
string
obligatoire
country_code
string
obligatoire
identity_id
nullable string
obligatoire

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

satisfied
boolean
obligatoire

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
obligatoire

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

Afficher les attributs enfants
created_at
string
obligatoire

When this was submitted.

updated_at
string
obligatoire

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.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.