> Tychron Atlas API & Provisioning Reference — chapter 31 of 35 as Markdown. Web version: https://docs.tychron.com/api-reference/events/
> 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

# Events

Events that can be sent from the system to a configured event subscription.

See [Event Subscriptions](https://docs.tychron.com/api-reference/event-subscriptions/#event-subscriptions) for details on registering your own subscription to receive these events.

Events are sent during the processing of a request, typically they are sent when:

* An `order` is completed (whether successful or failure)
* A `request` is completed (whether successful or failure)
* When a `DID` is created via request
* When a `DID` is deleted via request
* When a `DID` has a feature added (i.e. messaging, csp campaign, etc...)
* When a `DID` has a feature removed (i.e. messaging, csp campaign, etc...)

More events may be added in the future as needed.

## Schema

Format of the Subscription Event webhook.


__Type__ Object

| Name           | Type                                         | Description                       |
| -------------- | -------------------------------------------- | --------------------------------- |
| `associations` | `associations`                               | [Desc. `associations`](https://docs.tychron.com/api-reference/events/#desc-433) |
| `data`         | [One-Of](https://docs.tychron.com/api-reference/events/#type-434)                          |                                   |
| `id`           | String(format:ulid)                          | [Desc. `id`](https://docs.tychron.com/api-reference/events/#desc-435)           |
| `inserted_at`  | String(format:date-time)                     | [Desc. `inserted_at`](https://docs.tychron.com/api-reference/events/#desc-436)  |
| `timestamp`    | String(format:date-time)                     | [Desc. `timestamp`](https://docs.tychron.com/api-reference/events/#desc-437)    |
| `topic`        | [SystemEventTopic](https://docs.tychron.com/api-reference/schemas/#schema-systemeventtopic) |                                   |
| `type`         | [SystemEventType](https://docs.tychron.com/api-reference/schemas/#schema-systemeventtype)   |                                   |

#### Desc. `associations` {#desc-433}

Depending on the `type`, this field will contain additional associations of the parent record.

For example:

* `ORDER_COMPLETED` - will include `requests`
* `REQUEST_COMPLETED` - will include `provision_records`

#### One-Of {#type-434}

Types

* [SystemEventDataCspCampaignRegistered](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatacspcampaignregistered)
* [SystemEventDataCspCampaignOptoutItemCreated](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatacspcampaignoptoutitemcreated)
* [SystemEventDataCspCampaignOptoutItemDeleted](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatacspcampaignoptoutitemdeleted)
* [SystemEventDataDidCreated](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidcreated)
* [SystemEventDataDidDeleted](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadiddeleted)
* [SystemEventDataDidComponentCreated](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidcomponentcreated)
* [SystemEventDataDidComponentDeleted](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidcomponentdeleted)
* [SystemEventDataDidOptoutItemCreated](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidoptoutitemcreated)
* [SystemEventDataDidOptoutItemDeleted](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidoptoutitemdeleted)
* [SystemEventDataOsrOverwriteRequestPending](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdataosroverwriterequestpending)
* [SystemEventDataOsrOverwriteRequestCompleted](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdataosroverwriterequestcompleted)
* [SystemEventDataOrderCompleted](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdataordercompleted)
* [SystemEventDataRequestCompleted](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatarequestcompleted)

#### Desc. `id` {#desc-435}

Another format for UUID, used primarily for tasks, requests and messages.

#### Desc. `inserted_at` {#desc-436}

When was this event first created?

#### Desc. `timestamp` {#desc-437}

When was the event sent from the host system?

__associations__

| Name                | Type                                                                                         | Description |
| ------------------- | -------------------------------------------------------------------------------------------- | ----------- |
| `provision_records` | Array:[SystemEventAssociationProvisionRecord](https://docs.tychron.com/api-reference/schemas/#schema-systemeventassociationprovisionrecord) |             |
| `requests`          | Array:[SystemEventAssociationRequest](https://docs.tychron.com/api-reference/schemas/#schema-systemeventassociationrequest)                 |             |



__Example__

```json
{
  "associations": {
    "provision_records": [
      {
        "error_code": "OK",
        "id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
        "number": "12003004000",
        "status": "NONE"
      }
    ],
    "requests": [
      {
        "error_code": "OK",
        "id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
        "status": "NEW"
      }
    ]
  },
  "data": {
    "csp_campaign_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
    "tcr_campaign_id": "C000000"
  },
  "id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "inserted_at": "2021-08-13T04:08:44.762841Z",
  "timestamp": "2021-08-13T04:08:44.762841Z",
  "topic": "NONE",
  "type": "DID_CREATED"
}
```


## Request

Event Subscriptions control the request that will be made to the endpoint, while multiple protocols are listed, only HTTP is fully supported.

Requests will be retried up to 17 times of the course of 3 days.

The webhook system will accept any 2xx status as a success.

It is recommended that a `204 No Content` be returned while using the event subscription in case a response is supported by the webhook later.

## Types

### CSP Campaign Registered

#### Schema

`CSP_CAMPAIGN_REGISTERED`


__Type__ Object

| Name              | Type                | Description                          |
| ----------------- | ------------------- | ------------------------------------ |
| `csp_campaign_id` | String(format:ulid) | [Desc. `csp_campaign_id`](https://docs.tychron.com/api-reference/events/#desc-438) |
| `tcr_campaign_id` | String              | The TCR issued campaign ID           |

#### Desc. `csp_campaign_id` {#desc-438}

Another format for UUID, used primarily for tasks, requests and messages.



__Example__

```json
{
  "csp_campaign_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "tcr_campaign_id": "C000000"
}
```


### CSP Campaign - Optout Item - Created

#### Schema

`CSP_CAMPAIGN_OPTOUT_ITEM_CREATED`

The creation of an optout item is the explicit action of a subscriber opting out of receiving
messages.


__Type__ Object

| Name              | Type                | Description                          |
| ----------------- | ------------------- | ------------------------------------ |
| `csp_campaign_id` | String(format:ulid) | [Desc. `csp_campaign_id`](https://docs.tychron.com/api-reference/events/#desc-439) |
| `host_number`     | String              | [Desc. `host_number`](https://docs.tychron.com/api-reference/events/#desc-440)     |
| `keyword`         | String              | [Desc. `keyword`](https://docs.tychron.com/api-reference/events/#desc-441)         |
| `remote_number`   | String              | [Desc. `remote_number`](https://docs.tychron.com/api-reference/events/#desc-442)   |
| `tcr_campaign_id` | String              | The TCR issued campaign ID           |

#### Desc. `csp_campaign_id` {#desc-439}

Another format for UUID, used primarily for tasks, requests and messages.

#### Desc. `host_number` {#desc-440}

A reference to the host number that this optout belongs to.

That is the number that received the optout request.

#### Desc. `keyword` {#desc-441}

If the optout was triggered by the system, this field will be populated with the keyword
used.

Will be some variant of STOP normally.

For more information about keywords and their handling, contact support.

#### Desc. `remote_number` {#desc-442}

The client number that sent the optout, or is opted out of receiving messages from the
host number



__Example__

```json
{
  "csp_campaign_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "host_number": "12003004000",
  "keyword": "STOP",
  "remote_number": "12003004001",
  "tcr_campaign_id": "C000000"
}
```


### CSP Campaign - Optout Item - Deleted

#### Schema

`CSP_CAMPAIGN_OPTOUT_ITEM_DELETED`

While it may be confusing at first, the deletion of an optout item signifies that a subscriber,
as opted-in to receive messages and a restriction is no longer in place.


__Type__ Object

| Name              | Type                | Description                          |
| ----------------- | ------------------- | ------------------------------------ |
| `csp_campaign_id` | String(format:ulid) | [Desc. `csp_campaign_id`](https://docs.tychron.com/api-reference/events/#desc-443) |
| `host_number`     | String              | [Desc. `host_number`](https://docs.tychron.com/api-reference/events/#desc-444)     |
| `keyword`         | String              | [Desc. `keyword`](https://docs.tychron.com/api-reference/events/#desc-445)         |
| `remote_number`   | String              | [Desc. `remote_number`](https://docs.tychron.com/api-reference/events/#desc-446)   |
| `tcr_campaign_id` | String              | The TCR issued campaign ID           |

#### Desc. `csp_campaign_id` {#desc-443}

Another format for UUID, used primarily for tasks, requests and messages.

#### Desc. `host_number` {#desc-444}

A reference to the host number that this optout belongs to.

That is the number that received the optout request.

#### Desc. `keyword` {#desc-445}

If the optout was triggered by the system, this field will be populated with the keyword
used.

Will be some variant of STOP normally.

For more information about keywords and their handling, contact support.

#### Desc. `remote_number` {#desc-446}

The client number that sent the optout, or is opted out of receiving messages from the
host number



__Example__

```json
{
  "csp_campaign_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "host_number": "12003004000",
  "keyword": "STOP",
  "remote_number": "12003004001",
  "tcr_campaign_id": "C000000"
}
```


### DID Component Created

#### Schema

`DID_COMPONENT_CREATED`


__Type__ Object

| Name         | Type                                                                       | Description                     |
| ------------ | -------------------------------------------------------------------------- | ------------------------------- |
| `component`  | [SystemEventDataDidComponent](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidcomponent)         |                                 |
| `did_id`     | String(format:uuid)                                                        | [Desc. `did_id`](https://docs.tychron.com/api-reference/events/#desc-447)     |
| `number`     | String                                                                     | [Desc. `number`](https://docs.tychron.com/api-reference/events/#desc-448)     |
| `reason`     | [SystemEventDataDidCreatedReason](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidcreatedreason) |                                 |
| `request_id` | String(format:ulid)                                                        | [Desc. `request_id`](https://docs.tychron.com/api-reference/events/#desc-449) |

#### Desc. `did_id` {#desc-447}

A Universally unique identifier, which identifies the resource

#### Desc. `number` {#desc-448}

The 3 to 15 digit code of the number.

#### Desc. `request_id` {#desc-449}

Another format for UUID, used primarily for tasks, requests and messages.



__Example__

```json
{
  "component": "UNKNOWN",
  "did_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
  "number": "12003004000",
  "reason": "UNKNOWN",
  "request_id": "01EH2Y28M6KXG14QMPM3HSP1Y0"
}
```


### DID Component Deleted

#### Schema

`DID_COMPONENT_DELETED`


__Type__ Object

| Name         | Type                                                                       | Description                     |
| ------------ | -------------------------------------------------------------------------- | ------------------------------- |
| `component`  | [SystemEventDataDidComponent](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidcomponent)         |                                 |
| `did_id`     | String(format:uuid)                                                        | [Desc. `did_id`](https://docs.tychron.com/api-reference/events/#desc-450)     |
| `number`     | String                                                                     | [Desc. `number`](https://docs.tychron.com/api-reference/events/#desc-451)     |
| `reason`     | [SystemEventDataDidDeletedReason](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadiddeletedreason) |                                 |
| `request_id` | String(format:ulid)                                                        | [Desc. `request_id`](https://docs.tychron.com/api-reference/events/#desc-452) |

#### Desc. `did_id` {#desc-450}

A Universally unique identifier, which identifies the resource

#### Desc. `number` {#desc-451}

The 3 to 15 digit code of the number.

#### Desc. `request_id` {#desc-452}

Another format for UUID, used primarily for tasks, requests and messages.



__Example__

```json
{
  "component": "UNKNOWN",
  "did_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
  "number": "12003004000",
  "reason": "UNKNOWN",
  "request_id": "01EH2Y28M6KXG14QMPM3HSP1Y0"
}
```


### DID Created

#### Schema

`DID_CREATED`


__Type__ Object

| Name         | Type                                                                       | Description                     |
| ------------ | -------------------------------------------------------------------------- | ------------------------------- |
| `did_id`     | String(format:uuid)                                                        | [Desc. `did_id`](https://docs.tychron.com/api-reference/events/#desc-453)     |
| `number`     | String                                                                     | [Desc. `number`](https://docs.tychron.com/api-reference/events/#desc-454)     |
| `reason`     | [SystemEventDataDidCreatedReason](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadidcreatedreason) |                                 |
| `request_id` | String(format:ulid)                                                        | [Desc. `request_id`](https://docs.tychron.com/api-reference/events/#desc-455) |

#### Desc. `did_id` {#desc-453}

A Universally unique identifier, which identifies the resource

#### Desc. `number` {#desc-454}

The 3 to 15 digit code of the number.

#### Desc. `request_id` {#desc-455}

Another format for UUID, used primarily for tasks, requests and messages.



__Example__

```json
{
  "did_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
  "number": "12003004000",
  "reason": "UNKNOWN",
  "request_id": "01EH2Y28M6KXG14QMPM3HSP1Y0"
}
```


### DID Deleted

#### Schema

`DID_DELETED`


__Type__ Object

| Name         | Type                                                                       | Description                     |
| ------------ | -------------------------------------------------------------------------- | ------------------------------- |
| `did_id`     | String(format:uuid)                                                        | [Desc. `did_id`](https://docs.tychron.com/api-reference/events/#desc-456)     |
| `number`     | String                                                                     | [Desc. `number`](https://docs.tychron.com/api-reference/events/#desc-457)     |
| `reason`     | [SystemEventDataDidDeletedReason](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatadiddeletedreason) |                                 |
| `request_id` | String(format:ulid)                                                        | [Desc. `request_id`](https://docs.tychron.com/api-reference/events/#desc-458) |

#### Desc. `did_id` {#desc-456}

A Universally unique identifier, which identifies the resource

#### Desc. `number` {#desc-457}

The 3 to 15 digit code of the number.

#### Desc. `request_id` {#desc-458}

Another format for UUID, used primarily for tasks, requests and messages.



__Example__

```json
{
  "did_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
  "number": "12003004000",
  "reason": "UNKNOWN",
  "request_id": "01EH2Y28M6KXG14QMPM3HSP1Y0"
}
```


### DID - Optout Item - Created

#### Schema

`DID_OPTOUT_ITEM_CREATED`

The creation of an optout item is the explicit action of a subscriber opting out of receiving
messages.


__Type__ Object

| Name            | Type                | Description                        |
| --------------- | ------------------- | ---------------------------------- |
| `host_did_id`   | String(format:uuid) | [Desc. `host_did_id`](https://docs.tychron.com/api-reference/events/#desc-459)   |
| `host_number`   | String              | [Desc. `host_number`](https://docs.tychron.com/api-reference/events/#desc-460)   |
| `keyword`       | String              | [Desc. `keyword`](https://docs.tychron.com/api-reference/events/#desc-461)       |
| `remote_number` | String              | [Desc. `remote_number`](https://docs.tychron.com/api-reference/events/#desc-462) |

#### Desc. `host_did_id` {#desc-459}

A Universally unique identifier, which identifies the resource

#### Desc. `host_number` {#desc-460}

A reference to the host number that this optout belongs to.

That is the number that received the optout request.

#### Desc. `keyword` {#desc-461}

If the optout was triggered by the system, this field will be populated with the keyword
used.

Will be some variant of STOP normally.

For more information about keywords and their handling, contact support.

#### Desc. `remote_number` {#desc-462}

The client number that sent the optout, or is opted out of receiving messages from the
host number



__Example__

```json
{
  "host_did_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
  "host_number": "12003004000",
  "keyword": "STOP",
  "remote_number": "12003004001"
}
```


### DID - Optout Item - Deleted

#### Schema

`DID_OPTOUT_ITEM_DELETED`

While it may be confusing at first, the deletion of an optout item signifies that a subscriber,
as opted-in to receive messages and a restriction is no longer in place.


__Type__ Object

| Name            | Type                | Description                        |
| --------------- | ------------------- | ---------------------------------- |
| `host_did_id`   | String(format:uuid) | [Desc. `host_did_id`](https://docs.tychron.com/api-reference/events/#desc-463)   |
| `host_number`   | String              | [Desc. `host_number`](https://docs.tychron.com/api-reference/events/#desc-464)   |
| `keyword`       | String              | [Desc. `keyword`](https://docs.tychron.com/api-reference/events/#desc-465)       |
| `remote_number` | String              | [Desc. `remote_number`](https://docs.tychron.com/api-reference/events/#desc-466) |

#### Desc. `host_did_id` {#desc-463}

A Universally unique identifier, which identifies the resource

#### Desc. `host_number` {#desc-464}

A reference to the host number that this optout belongs to.

That is the number that received the optout request.

#### Desc. `keyword` {#desc-465}

If the optout was triggered by the system, this field will be populated with the keyword
used.

Will be some variant of STOP normally.

For more information about keywords and their handling, contact support.

#### Desc. `remote_number` {#desc-466}

The client number that sent the optout, or is opted out of receiving messages from the
host number



__Example__

```json
{
  "host_did_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
  "host_number": "12003004000",
  "keyword": "STOP",
  "remote_number": "12003004001"
}
```


### Order Completed

#### Schema

`ORDER_COMPLETED`

This event is sent whenever an `ORDER` is considered complete, not necessarily `COMPLETED`.

The `requests` associations will be included in the parent System Event.

Note the `requests` association do not include their PVRs, you must have the REQUEST topic enabled to receive those details.


__Type__ Object

| Name         | Type                                     | Description                   |
| ------------ | ---------------------------------------- | ----------------------------- |
| `error_code` | [OrderErrorCode](https://docs.tychron.com/api-reference/schemas/#schema-ordererrorcode) |                               |
| `order_id`   | String(format:ulid)                      | [Desc. `order_id`](https://docs.tychron.com/api-reference/events/#desc-467) |
| `status`     | [OrderStatus](https://docs.tychron.com/api-reference/schemas/#schema-orderstatus)       |                               |

#### Desc. `order_id` {#desc-467}

Another format for UUID, used primarily for tasks, requests and messages.



__Example__

```json
{
  "error_code": "OK",
  "order_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "status": "NEW"
}
```


### Request Completed

#### Schema

`REQUEST_COMPLETED`

This event is sent whenever a `REQUEST` is considered complete (not necessarily `COMPLETED`, it may be an `ERROR` as well).

The parent System Event will contain the `provision_records` associations which give a finer detail of what specific items were completed or had errors.


__Type__ Object

| Name         | Type                                     | Description                     |
| ------------ | ---------------------------------------- | ------------------------------- |
| `data`       | [One-Of](https://docs.tychron.com/api-reference/events/#type-468)                      |                                 |
| `error_code` | [OrderErrorCode](https://docs.tychron.com/api-reference/schemas/#schema-ordererrorcode) |                                 |
| `order_id`   | String(format:ulid)                      | [Desc. `order_id`](https://docs.tychron.com/api-reference/events/#desc-469)   |
| `request_id` | String(format:ulid)                      | [Desc. `request_id`](https://docs.tychron.com/api-reference/events/#desc-470) |
| `status`     | [OrderStatus](https://docs.tychron.com/api-reference/schemas/#schema-orderstatus)       |                                 |
| `type`       | [RequestType](https://docs.tychron.com/api-reference/schemas/#schema-requesttype)       |                                 |

#### One-Of {#type-468}

Types

* [SystemEventDataRequestCompletedDataRegisterBrand](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatarequestcompleteddataregisterbrand)
* [SystemEventDataRequestCompletedDataRegisterCampaign](https://docs.tychron.com/api-reference/schemas/#schema-systemeventdatarequestcompleteddataregistercampaign)

#### Desc. `order_id` {#desc-469}

Another format for UUID, used primarily for tasks, requests and messages.

#### Desc. `request_id` {#desc-470}

Another format for UUID, used primarily for tasks, requests and messages.



__Example__

```json
{
  "data": {
    "brand_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
    "tcr_brand_id": "B123456"
  },
  "error_code": "OK",
  "order_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "request_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "status": "NEW",
  "type": "ADD_CAMPAIGN_NUMBERS"
}
```


### OSR Overwrite Request Pending

#### Schema

`OSR_OVERWRITE_REQUEST_PENDING`


__Type__ Object

| Name                        | Type                     | Description                                   |
| --------------------------- | ------------------------ | --------------------------------------------- |
| `did_id`                    | String(format:uuid)      | [Desc. `did_id`](https://docs.tychron.com/api-reference/events/#desc-471)                   |
| `error_code`                | Enum(`OK`):String        | Further explanation of an error status        |
| `new_nnid_service_provider` | String                   |                                               |
| `number`                    | String                   | [Desc. `number`](https://docs.tychron.com/api-reference/events/#desc-472)                   |
| `osr_overwrite_request_id`  | String(format:ulid)      | [Desc. `osr_overwrite_request_id`](https://docs.tychron.com/api-reference/events/#desc-473) |
| `review_status`             | [Enum](https://docs.tychron.com/api-reference/events/#enum-474):String | [Desc. `review_status`](https://docs.tychron.com/api-reference/events/#desc-475)            |
| `status`                    | [Enum](https://docs.tychron.com/api-reference/events/#enum-476):String | [Desc. `status`](https://docs.tychron.com/api-reference/events/#desc-477)                   |

#### Desc. `did_id` {#desc-471}

A Universally unique identifier, which identifies the resource

#### Desc. `number` {#desc-472}

The 3 to 15 digit code of the number.

#### Desc. `osr_overwrite_request_id` {#desc-473}

Another format for UUID, used primarily for tasks, requests and messages.

#### Enum Values review_status {#enum-474}

Allowed values

* `NONE`
* `APPROVED`
* `REJECTED`
* `AUTO_APPROVED`
* `AUTO_REJECTED`
* `FORCE_DELETED`

#### Desc. `review_status` {#desc-475}

The review status of the request, defaults to NONE.

#### Enum Values status {#enum-476}

Allowed values

* `NEW`
* `REVIEWED`
* `APPROVED`
* `REJECTED`
* `ERROR`
* `STALE`
* `DELETED`

#### Desc. `status` {#desc-477}

The current processing status of the request



__Example__

```json
{
  "did_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
  "error_code": "OK",
  "new_nnid_service_provider": "ACME Corp",
  "number": "12003004000",
  "osr_overwrite_request_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "review_status": "NONE",
  "status": "NEW"
}
```


### OSR Overwrite Request Completed

#### Schema

`OSR_OVERWRITE_REQUEST_COMPLETED`


__Type__ Object

| Name                        | Type                     | Description                                   |
| --------------------------- | ------------------------ | --------------------------------------------- |
| `did_id`                    | String(format:uuid)      | [Desc. `did_id`](https://docs.tychron.com/api-reference/events/#desc-478)                   |
| `error_code`                | Enum(`OK`):String        | Further explanation of an error status        |
| `new_nnid_service_provider` | String                   |                                               |
| `number`                    | String                   | [Desc. `number`](https://docs.tychron.com/api-reference/events/#desc-479)                   |
| `osr_overwrite_request_id`  | String(format:ulid)      | [Desc. `osr_overwrite_request_id`](https://docs.tychron.com/api-reference/events/#desc-480) |
| `review_status`             | [Enum](https://docs.tychron.com/api-reference/events/#enum-481):String | [Desc. `review_status`](https://docs.tychron.com/api-reference/events/#desc-482)            |
| `status`                    | [Enum](https://docs.tychron.com/api-reference/events/#enum-483):String | [Desc. `status`](https://docs.tychron.com/api-reference/events/#desc-484)                   |

#### Desc. `did_id` {#desc-478}

A Universally unique identifier, which identifies the resource

#### Desc. `number` {#desc-479}

The 3 to 15 digit code of the number.

#### Desc. `osr_overwrite_request_id` {#desc-480}

Another format for UUID, used primarily for tasks, requests and messages.

#### Enum Values review_status {#enum-481}

Allowed values

* `NONE`
* `APPROVED`
* `REJECTED`
* `AUTO_APPROVED`
* `AUTO_REJECTED`
* `FORCE_DELETED`

#### Desc. `review_status` {#desc-482}

The review status of the request, defaults to NONE.

#### Enum Values status {#enum-483}

Allowed values

* `NEW`
* `REVIEWED`
* `APPROVED`
* `REJECTED`
* `ERROR`
* `STALE`
* `DELETED`

#### Desc. `status` {#desc-484}

The current processing status of the request



__Example__

```json
{
  "did_id": "c6be45e4-b7dd-412c-96c4-777e83fb9c48",
  "error_code": "OK",
  "new_nnid_service_provider": "ACME Corp",
  "number": "12003004000",
  "osr_overwrite_request_id": "01EH2Y28M6KXG14QMPM3HSP1Y0",
  "review_status": "NONE",
  "status": "NEW"
}
```

---

Previous chapter: https://docs.tychron.com/api-reference/event-subscriptions.md  
Next chapter: https://docs.tychron.com/api-reference/smpp.md  
Complete reference in one file: https://docs.tychron.com/llms-full.txt