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.
Parameter
submission_idstringSubmission ID.
Antwort-Payload
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.
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.
Untergeordnete Attribute anzeigen
items.inheritedtrue 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.iditems.keyThe requirement this answers.
items.stateitems.valueYour 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_idThe document you supplied, for a requirement that takes one. null otherwise.
items.valuesYour answers, for a requirement that takes several and is answered inline. null for one answered once. Order is as you sent it.
items.attachment_idsThe documents you supplied, for a requirement that takes several. null otherwise.
items.reasonWhy this was rejected, when it was. null otherwise.
items.decided_atWhen this was decided. null while no decision has been made.
items.expires_atWhen this answer goes stale and must be supplied again. null when it does not expire.
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.
Verwandte Ressourcen
Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.