bird compliance submissions create

Usage

Esempio di codice

bird compliance submissions create [flags]

Files a country's registration answers, all of them in one call, and there is no draft to build up first. What to send is bird compliance requirements's fields, item by item; a country it does not cover is refused rather than accepted empty. Filing twice for the same registration returns 409, so correct a refused answer with bird compliance submissions resupply instead. The answers are a legal representation about the business, relayed onward to a carrier or a regulator under the name of the business they describe, so confirm them with the user before this call rather than filing on your own.

Build the request from flags, a JSON ComplianceSubmissionCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Esempio di codice

# print the body shape (no credentials needed)
bird compliance submissions create --example

# the body it prints:

Esempio di codice

{
  "answers": [
    {
      "key": "business_registration_number",
      "value": "90012768"
    }
  ],
  "country_code": "US",
  "identity": {
    "name": "Goldcrest Communications SAS"
  },
  "identity_id": "cid_01krdgeqcxet5s7t44vh8rt9mg",
  "program": "alpha",
  "subject_id": "scr_01krdgeqcxet5s7t44vh8rt9mg",
  "subject_kind": "sms_sender"
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--subject-kind	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. (required; or in --body-file)
--subject-id	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. (required; or in --body-file)
--program	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. Known values: alpha, numeric, mobile, local, national, short_code, short_code_fteu, toll_free, business (others may exist). (required; or in --body-file)
--country-code	ISO 3166-1 alpha-2 country code. (required; or in --body-file)
--identity-id	An existing party this registration is for. It fills in the business details you left out from what that party already holds, and an answer approved here is written back onto it for next time. Send this or identity, never both. An id belonging to another organization is rejected; nothing is created here. When subject_kind is identity, send neither: subject_id already names the party.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird compliance submissions get	Get a submission
bird compliance submissions resupply	Update rejected answers