Skip to content
Registry

The registry in use and how many of the organisation's passports need an update

Scope: readSee also:Authentication ·Errors ·Pagination ·Rate limits
GET
/registry/status

Any member. After a new registry version is deployed, a job re-evaluates the organisation's published passports; passports with a newly missing required value become update_needed (they stay online) and their versions get an update_passports task.

Authorization

apiKey
headerAuthorizationBearer <token>

Organisation API key sent as Authorization: Bearer bp_live_… (ADR-017). Accepted only by the operations that list this scheme, with the scope in their x-api-key-scope.

Response Body

The status.

application/json
  1. response
reevaluation?

created_by names the member who started the job, created_by_api_key the API key that started an import validation (ADR-026); a job without either was started by the system (the registry re-evaluation).

registry_hash*string
registry_status*RegistryStatus

seed until verified against primary sources (docs/registry/verification-log.md).

Value in"seed""verified"
registry_version*string
update_needed*integer

The organisation's passports in status update_needed.

Example Request
curl -X GET 'https://example.com/api/v1/registry/status'
Example Response
{  "reevaluation": {    "created_at": "2019-08-24T14:15:22Z",    "created_by": {      "display_name": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"    },    "created_by_api_key": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string"    },    "error_code": "forbidden",    "file": {      "content_type": "string",      "expires_at": "2019-08-24T14:15:22Z",      "filename": "string",      "size": 0    },    "finished_at": "2019-08-24T14:15:22Z",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "import_id": "13230382-dadc-41f2-963d-e123bd5c0585",    "kind": "import_validate",    "progress": {      "done": 0,      "total": 0    },    "result": {      "approval": {        "approved": 0,        "not_approved": 0,        "reasons": {          "checks_failed": 0,          "conflict": 0,          "evidence_required": 0,          "four_eyes": 0,          "import_warning": 0        },        "units": 0      },      "detail": "string",      "export": {        "bytes": 0,        "files": 0,        "format": "string",        "records": {          "property1": 0,          "property2": 0        }      },      "import_summary": {        "approved": 0,        "created": 0,        "duplicates": 0,        "errors": 0,        "not_approved": 0,        "rows": 0,        "valid": 0,        "warnings": 0      },      "outcomes": {        "blocked": 0,        "exported": 0,        "failed": 0,        "published": 0,        "skipped": 0,        "unchanged": 0      },      "reevaluation": {        "checked": 0,        "registry_version": "string",        "update_needed": 0      },      "units": 0    },    "started_at": "2019-08-24T14:15:22Z",    "status": "queued"  },  "registry_hash": "string",  "registry_status": "seed",  "registry_version": "string",  "update_needed": 0}