Get a submission
/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 ?? "");
}submission = client.compliance_submissions.get("csb_01krdgeqcxet5s7t44vh8rt9mg")
for item in submission.items or []:
print(item.key, item.state, item.reason or "")submission, err := client.ComplianceSubmissions.Get(context.Background(), "csb_01krdgeqcxet5s7t44vh8rt9mg")
if err != nil {
log.Fatal(err)
}
for _, item := range *submission.Items {
fmt.Println(*item.Key, *item.State)
}$submission = $bird->complianceSubmissions->get('csb_01krdgeqcxet5s7t44vh8rt9mg');
foreach ($submission->getItems() ?? [] as $item) {
echo $item->getKey(), ' ', $item->getState(), ' ', $item->getReason() ?? '', "\n";
}bird compliance submissions get <submission-id>curl -X GET "https://us1.platform.bird.com/v1/compliance/submissions/{submission_id}" \
-H "Authorization: Bearer $TOKEN"{
"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.
Parametri
submission_idstringSubmission ID.
Payload di risposta
nextWhat 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.
Mostra attributi secondari
next.kindWhat you do about this step.
operation: call the operation named inoperation, 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.descriptionA short, human-readable label for the step, suitable for display.
next.operationThe 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.paramsThe 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.urlA 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.
idsubject_kindsubject_idprogramcountry_codeidentity_idThe party this registration was filed for, or null if none was named.
satisfiedWhether 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.
itemsEvery answer and where it stands. Each is decided on its own.
created_atWhen this was submitted.
updated_atWhen it last changed.
closed_atWhen this submission was closed. Null while it remains open.
closure_reasonThe decline reason for a closed submission, or null while open.
Risorse correlate
Continua con la documentazione, le guide e gli esempi per questo argomento.