> Tychron Atlas API & Provisioning Reference — chapter 24 of 35 as Markdown. Web version: https://docs.tychron.com/api-reference/osr-overwrite-requests/ > Source: https://docs.tychron.com/api-reference/ · Updated 2026-08-12 · Generated from the Atlas OpenAPI spec (https://api.atlas.tychron.online/api/v1/openapi is the live contract; this file is a dated snapshot of it). > Source revision: atlas_api_reference_2026-08-12.md · sha256 482ebd3b014af053 · sanitize gate v1 clean · reconciled with OpenAPI 2026.8.25-p01 (spec sha256 cc049ef38c71cd6e) on 2026-09-05 · content last modified 2026-09-09 · newer definition under review since 2026-09-09 (not yet reconciled) > Scope: the Atlas platform API only. The SMS, MMS, CNAM, LRN and MCL services are separate APIs with their own specifications: https://docs.tychron.com/openapi/ > Machine index: https://docs.tychron.com/llms.txt # OSR Overwrite Requests ## Schema A request created whenever a request to delete or overwrite an sms enabled numbers __Type__ Object | Name | Type | Description | | --------------- | ------------------------ | -------------------------------------- | | `activation` | String(format:date-time) | An ISO8601 formatted timestamp | | `error_code` | Enum(`OK`):String | Further explanation of an error status | | `expires_at` | String(format:date-time) | An ISO8601 formatted timestamp | | `id` | String(format:ulid) | [Desc. `id`](https://docs.tychron.com/api-reference/osr-overwrite-requests/#desc-363) | | `inserted_at` | String(format:date-time) | An ISO8601 formatted timestamp | | `is_stale` | Boolean | | | `review_status` | [Enum](https://docs.tychron.com/api-reference/osr-overwrite-requests/#enum-364):String | [Desc. `review_status`](https://docs.tychron.com/api-reference/osr-overwrite-requests/#desc-365) | | `status` | [Enum](https://docs.tychron.com/api-reference/osr-overwrite-requests/#enum-366):String | [Desc. `status`](https://docs.tychron.com/api-reference/osr-overwrite-requests/#desc-367) | | `tn` | String | | | `updated_at` | String(format:date-time) | An ISO8601 formatted timestamp | #### Desc. `id` {#desc-363} Another format for UUID, used primarily for tasks, requests and messages. #### Enum Values review_status {#enum-364} Allowed values * `NONE` * `APPROVED` * `REJECTED` * `AUTO_APPROVED` * `AUTO_REJECTED` * `FORCE_DELETED` #### Desc. `review_status` {#desc-365} The review status of the request, defaults to NONE. #### Enum Values status {#enum-366} Allowed values * `NEW` * `REVIEWED` * `APPROVED` * `REJECTED` * `ERROR` * `STALE` * `DELETED` #### Desc. `status` {#desc-367} The current processing status of the request __Example__ ```json { "activation": "2021-08-13T04:08:44.762841Z", "error_code": "OK", "expires_at": "2021-08-13T04:08:44.762841Z", "id": "01EH2Y28M6KXG14QMPM3HSP1Y0", "inserted_at": "2021-08-13T04:08:44.762841Z", "is_stale": true, "review_status": "NONE", "status": "NEW", "tn": "12003004000", "updated_at": "2021-08-13T04:08:44.762841Z" } ``` ## Summary ## API ### Review OSR Overwrite Request ```http POST /api/v1/osr/overwrite_requests/{overwrite_request_id}/review HTTP/1.1 ``` Review an existing Overwrite Request. Note a request that has already been reviewed wil perform a no-op. #### Request application/json ```http POST /api/v1/osr/overwrite_requests/{overwrite_request_id}/review HTTP/1.1 Accept: application/json, Content-Type: application/json Content-Length: 82 ``` ```json { "data": { "review_status": "NONE" }, "type": "osr_overwrite_request" } ``` #### Response 200 ##### application/json ```http HTTP/1.1 200 Content-Type: application/json Content-Length: 741 ``` ```json { "associations": { "did": { "id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48", "number": "12003004000" }, "new_nnid_entry": { "service_provider": "ACME Corp" }, "reviewed_user": { "first_name": "John", "id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48", "last_name": "Doe" } }, "data": { "activation": "2021-08-13T04:08:44.762841Z", "error_code": "OK", "expires_at": "2021-08-13T04:08:44.762841Z", "id": "01EH2Y28M6KXG14QMPM3HSP1Y0", "inserted_at": "2021-08-13T04:08:44.762841Z", "is_stale": true, "review_status": "NONE", "status": "NEW", "tn": "12003004000", "updated_at": "2021-08-13T04:08:44.762841Z" }, "type": "osr_overwrite_request" } ``` #### Response 204 ##### No Content ```http HTTP/1.1 204 ``` #### Response 403 ##### application/json ```http HTTP/1.1 403 Content-Type: application/json Content-Length: 312 ``` ```json { "errors": [ { "code": "access_denied.no_scope", "detail": "No scope available to user role", "params": { "action": "index", "level": "guest", "resource": "resource" }, "sub_code": "none", "title": "Access Denied, no scope available" } ] } ``` #### Response 404 ##### application/json ```http HTTP/1.1 404 Content-Type: application/json Content-Length: 241 ``` ```json { "errors": [ { "code": "invalid_parameter", "detail": "The specified resource could not be found", "source": { "pointer": "/data/type" }, "sub_code": "none", "title": "Not Found" } ] } ``` ### List OSR Overwrite Requests ```http GET /api/v1/osr/overwrite_requests HTTP/1.1 ``` Retrieve a list of overwrite requests, latest requests are always first __Query Parameters__ | Name | Type | Description | | ------ | ------- | ------------------------------- | | first | Integer | [Query Desc. first](https://docs.tychron.com/api-reference/osr-overwrite-requests/#desc-368) | | last | Integer | [Query Desc. last](https://docs.tychron.com/api-reference/osr-overwrite-requests/#desc-369) | | after | String | [Query Desc. after](https://docs.tychron.com/api-reference/osr-overwrite-requests/#desc-370) | | before | String | [Query Desc. before](https://docs.tychron.com/api-reference/osr-overwrite-requests/#desc-371) | #### Query Desc. first {#desc-368} The number of items to return starting from the 'after' cursor #### Query Desc. last {#desc-369} The number of items to return behind the 'before' cursor #### Query Desc. after {#desc-370} The cursor representing the starting point of a 'first' based paging #### Query Desc. before {#desc-371} The cursor representing the starting point of a 'last' based paging #### Request ```http GET /api/v1/osr/overwrite_requests HTTP/1.1 Accept: application/json ``` #### Response 200 ##### application/json ```http HTTP/1.1 200 Content-Type: application/json Content-Length: 1018 ``` ```json { "count": 1, "page_info": { "first": "string", "has_next_page": true, "has_previous_page": true, "last": "string" }, "results": [ { "associations": { "did": { "id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48", "number": "12003004000" }, "new_nnid_entry": { "service_provider": "ACME Corp" }, "reviewed_user": { "first_name": "John", "id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48", "last_name": "Doe" } }, "data": { "activation": "2021-08-13T04:08:44.762841Z", "error_code": "OK", "expires_at": "2021-08-13T04:08:44.762841Z", "id": "01EH2Y28M6KXG14QMPM3HSP1Y0", "inserted_at": "2021-08-13T04:08:44.762841Z", "is_stale": true, "review_status": "NONE", "status": "NEW", "tn": "12003004000", "updated_at": "2021-08-13T04:08:44.762841Z" }, "type": "osr_overwrite_request" } ] } ``` #### Response 403 ##### application/json ```http HTTP/1.1 403 Content-Type: application/json Content-Length: 312 ``` ```json { "errors": [ { "code": "access_denied.no_scope", "detail": "No scope available to user role", "params": { "action": "index", "level": "guest", "resource": "resource" }, "sub_code": "none", "title": "Access Denied, no scope available" } ] } ``` ### Get OSR Overwrite Request ```http GET /api/v1/osr/overwrite_requests/{id} HTTP/1.1 ``` Lookup an Overwrite Request by its ID __Path Parameters__ | Name | Type | Description | | ---- | -------------------- | ------------------------ | | id | String(format:uuid)! | OSR Overwrite Request ID | #### Request ```http GET /api/v1/osr/overwrite_requests/{id} HTTP/1.1 Accept: application/json ``` #### Response 200 ##### application/json ```http HTTP/1.1 200 Content-Type: application/json Content-Length: 741 ``` ```json { "associations": { "did": { "id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48", "number": "12003004000" }, "new_nnid_entry": { "service_provider": "ACME Corp" }, "reviewed_user": { "first_name": "John", "id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48", "last_name": "Doe" } }, "data": { "activation": "2021-08-13T04:08:44.762841Z", "error_code": "OK", "expires_at": "2021-08-13T04:08:44.762841Z", "id": "01EH2Y28M6KXG14QMPM3HSP1Y0", "inserted_at": "2021-08-13T04:08:44.762841Z", "is_stale": true, "review_status": "NONE", "status": "NEW", "tn": "12003004000", "updated_at": "2021-08-13T04:08:44.762841Z" }, "type": "osr_overwrite_request" } ``` #### Response 403 ##### application/json ```http HTTP/1.1 403 Content-Type: application/json Content-Length: 312 ``` ```json { "errors": [ { "code": "access_denied.no_scope", "detail": "No scope available to user role", "params": { "action": "index", "level": "guest", "resource": "resource" }, "sub_code": "none", "title": "Access Denied, no scope available" } ] } ``` #### Response 404 ##### application/json ```http HTTP/1.1 404 Content-Type: application/json Content-Length: 314 ``` ```json { "errors": [ { "code": "not_found", "detail": "The specified resource could not be found", "params": { "resource": { "id": "3fbb573a-6049-44a0-a12c-d3a1ffae0b69", "type": "user" } }, "sub_code": "none", "title": "Not Found" } ] } ``` --- Previous chapter: https://docs.tychron.com/api-reference/did-optout-items.md Next chapter: https://docs.tychron.com/api-reference/csp-enums.md Complete reference in one file: https://docs.tychron.com/llms-full.txt