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);

submission = client.compliance_submissions.resupply(
    "csb_01krdgeqcxet5s7t44vh8rt9mg",
    answers=[{"key": "business_registration_number", "value": "90012769"}],
)
print(submission.satisfied)

submission, err := client.ComplianceSubmissions.Resupply(context.Background(), "csb_01krdgeqcxet5s7t44vh8rt9mg", bird.ComplianceSubmissionsResupplyParams{
	Answers: []bird.ComplianceAnswer{
		{Key: "business_registration_number", Value: bird.Ptr("90012769")},
	},
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(*submission.Satisfied)

$submission = $bird->complianceSubmissions->resupply(
    'csb_01krdgeqcxet5s7t44vh8rt9mg',
    (new ComplianceSubmissionResupply())->setAnswers([
        (new ComplianceAnswer())->setKey('business_registration_number')->setValue('90012769'),
    ]),
);
echo $submission->getSatisfied() ? 'satisfied' : 'outstanding', "\n";

bird compliance submissions resupply <submission-id> --body-file - <<'JSON'
{
  "answers": [
    {
      "key": "business_registration_number",
      "value": "90012768"
    }
  ]
}
JSON

curl -X POST "https://us1.platform.bird.com/v1/compliance/submissions/{submission_id}/resupply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "answers": [
      {
        "key": "business_registration_number",
        "value": "90012768"
      }
    ]
  }'

Resposta200

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

Parâmetros

submission_idstring

Submission ID.

Corpo da requisição

answers

array

obrigatório

Mostrar parâmetros secundários

answers.key

string

obrigatório

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

answers.value

string

obrigatório

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

answers.key

string

obrigatório

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

answers.attachment_id

string

obrigatório

The uploaded document, for a requirement that takes one. Upload the file as an attachment first, then send the id it returns.

answers.key

string

obrigatório

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

answers.values

array of string

obrigatório

The answers, for a requirement whose max_items is set and which is answered inline. Send each as a string whatever its data type, and send them in the order you mean them to be read. At most max_items of them.

answers.key

string

obrigatório

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

answers.attachment_ids

array of string

obrigatório

The uploaded documents, for a requirement whose max_items is set and which takes documents. Upload each file first and send the ids it returns, in order. At most max_items of them.

Payload de resposta

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.

Mostrar atributos secundários

id

string

obrigatório

subject_kind

string

obrigatório

What is being registered.

sms_sender: a sender registered to send to one country.
number: a phone number you hold that needs ownership paperwork before it can carry traffic.
identity: a business you operate as, registered once and reused by later registrations that name it.

Possible values: sms_sender, number, identity

subject_id

string

obrigatório

What is being registered. For sms_sender this is the scr_ id returned when you register a sender for a country. For number it is the nda_ id of a dedicated number you hold, as returned by GET /v1/numbers. A shared short code (nal_) is not accepted: it is shared, so its ownership paperwork is not yours to file. For identity it is the cid_ id of the party being registered, picked from the parties your workspace holds, as returned by GET /v1/compliance/identities.

program

string

obrigatório

The registration program a country runs. Available programs depend on the registered resource. An SMS sender registers under an authority regime (alpha or numeric). A phone number proves ownership under its number type (mobile, local, national, short_code, short_code_fteu, or toll_free), matching the values of NumberType. An identity registers your business itself under business, internationally: its coordinate's country is always ZZ. A value is therefore only meaningful alongside the subject it describes. More are added as coverage grows, so treat this as an open set rather than a fixed list.

Possible values (may grow over time): alpha, numeric, mobile, local, national, short_code, short_code_fteu, toll_free, business

country_code

string

obrigatório

ISO 3166-1 alpha-2 country code.

identity_id

nullable string

obrigatório

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

satisfied

boolean

obrigatório

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

obrigatório

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

Mostrar atributos secundários

created_at

string

obrigatório

When this was submitted.

updated_at

string

obrigatório

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.

Continue com a documentação, guias e exemplos sobre este tópico.

Obtenha um resumo de implementação

const submission = await bird.complianceSubmissions.resupply(
  "csb_01krdgeqcxet5s7t44vh8rt9mg",
  {
    answers: [{ key: "business_registration_number", value: "90012769" }],
  },
);
console.log(submission.satisfied);

submission = client.compliance_submissions.resupply(
    "csb_01krdgeqcxet5s7t44vh8rt9mg",
    answers=[{"key": "business_registration_number", "value": "90012769"}],
)
print(submission.satisfied)

submission, err := client.ComplianceSubmissions.Resupply(context.Background(), "csb_01krdgeqcxet5s7t44vh8rt9mg", bird.ComplianceSubmissionsResupplyParams{
	Answers: []bird.ComplianceAnswer{
		{Key: "business_registration_number", Value: bird.Ptr("90012769")},
	},
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(*submission.Satisfied)

$submission = $bird->complianceSubmissions->resupply(
    'csb_01krdgeqcxet5s7t44vh8rt9mg',
    (new ComplianceSubmissionResupply())->setAnswers([
        (new ComplianceAnswer())->setKey('business_registration_number')->setValue('90012769'),
    ]),
);
echo $submission->getSatisfied() ? 'satisfied' : 'outstanding', "\n";

bird compliance submissions resupply <submission-id> --body-file - <<'JSON'
{
  "answers": [
    {
      "key": "business_registration_number",
      "value": "90012768"
    }
  ]
}
JSON

curl -X POST "https://us1.platform.bird.com/v1/compliance/submissions/{submission_id}/resupply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "answers": [
      {
        "key": "business_registration_number",
        "value": "90012768"
      }
    ]
  }'

Resposta200

{
  "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"
      ]
    }
  ]
}

Update compliance answers

Parâmetros

Corpo da requisição

Payload de resposta

Recursos relacionados