How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bureau of Consular Affairs Write API

Write actions (require API token).

Bureau of Consular Affairs Write API is one of 8 APIs that Bureau of Consular Affairs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against a single base URL, https://cadatacatalog.state.gov/api/3.

3 operations 3 paths 4 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
https://cadatacatalog.state.gov/api/3/action
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Bureau of Consular Affairs Write API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiToken).

  • apiToken — CKAN API token, generated from the CKAN user profile.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Write 3

Write actions (require API token).

POST
/action/package_create
Create a dataset (package)
packageCreate body → 200
POST
/action/package_update
Update a dataset (package)
packageUpdate body → 200
POST
/action/package_delete
Delete a dataset
packageDelete body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Package (18 properties), Resource (12 properties), SuccessBoolean (3 properties), PackageResult (3 properties). Each schema is shown below with its type and property counts.

Package
object
18 properties
Resource
object
12 properties
PackageResult
object
3 properties
SuccessBoolean
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bureau-of-consular-affairs-write-api-openapi.yml Raw ↑

Other APIs Bureau of Consular Affairs publishes across the network.

Bureau of Consular Affairs Data Catalog (CKAN API)
Travel Advisories API
Passport Issuance Statistics
Embassy and Consulate Locations
Intercountry Adoption Statistics
Bureau of Consular Affairs Datastore API
Bureau of Consular Affairs Discovery API
Where this information came from

This is an independent, third-party profile of Bureau of Consular Affairs Write API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.