esim-offers

Get country identification requirements for an eSIM offer

Returns identification guidance as a JSON Schema for each country in the offer's coverage zone. The schemas require first_name, last_name, and email, including countries with no additional requirements. Enable format assertions in your validator for email addresses and dates.

You collect and validate the information. Bird does not receive or verify the answers, and fetching or satisfying these schemas does not authorize a purchase or assignment.

get/v1/esim/offers/{offer_id}/requirements

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/esim/offers/{offer_id}/requirements
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

offer_idstring required
Example:eof_01krdgeqcxet5s7t44vh8rt9mg

Offer ID.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Requirements for the offer coverage countries.

Example response

{
  "countries": [
    {
      "country_code": "US"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.