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);
响应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"
      ]
    }
  ]
}

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.

参数

submission_idstring

Submission ID.

请求载荷

answers
array
必填
显示子参数

响应载荷

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
必填

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
必填

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
必填
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.

显示子属性
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.