V2
Insurance Device
Insurance provides users access to HBO content across various application and platform combinations including mobile devices, smart TVs, and desktop computers.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string | true | Unique request identifier |
| organization | path | string | true | Identificador único de la organización |
| body | body | InsuranceCreationRequestDTO | true | Device Insurance DTO request |
Request body - instance of InsuranceCreationRequestDTO
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| documentId | string | true | none |
| firstName | string | true | none |
| lastName1 | string | false | none |
| lastName2 | string | false | none |
| msisdn | string | false | none |
| address | string | false | none |
| string | true | none | |
| zipCode | string | false | none |
| locality | string | false | none |
| province | string | false | none |
| language | string | true | none |
| sfid | string | false | none |
| brand | string | true | none |
| model | string | true | none |
| price | number | true | none |
| clientType | string | false | none |
| invoicePayment | boolean | false | none |
| productType | string | false | none |
| imei | string | false | none |
| terminalSaleDate | string | false | none |
| entity | string | false | none |
| officeCode | string | false | none |
| dc | string | false | none |
| accountNumber | string | false | none |
| billingCycle | string | false | none |
| salesChannel | string | false | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Order created | InsuranceCreationResponseDTO |
| 400 | Bad Request | Error en los datos de la solicitud | None |
| 500 | Internal Server Error | Error interno del servidor | None |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string | true | Unique request identifier |
| organization | path | string | true | Identificador único de la organización |
| body | body | CancelInsuranceRequest | true | Datos para cancelar la póliza |
Request body - instance of CancelInsuranceRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| policyNumber | string | true | Número de póliza |
| document | string | false | Documento del asegurado |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The operation request was successfully accepted, returned the request external reference identifier | ProcessResponse |
| 400 | Bad Request | Error en los datos de la solicitud | None |
| 500 | Internal Server Error | Error interno del servidor | None |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string | true | Unique request identifier |
| organization | path | string | true | Identificador único de la organización |
| body | body | ActivateInsuranceRequest | true | Datos para activar la póliza |
Request body - instance of ActivateInsuranceRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | false | Referencia externa para la activación |
| requestId | string | true | Identificador único para la solicitud |
| policyNumber | string | true | Número de póliza |
| imei | string | true | IMEI del dispositivo |
| document | string | true | Documento del asegurado |
| subscriptionId | string | false | Identificador de la suscripción |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The operation request was successfully accepted, returned the request external reference identifier | ProcessResponse |
| 400 | Bad Request | Error en los datos de la solicitud | None |
| 500 | Internal Server Error | Error interno del servidor | None |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string | true | Unique request identifier |
| organization | path | string | true | Identificador único de la organización |
| body | body | TerminateInsuranceRequest | true | Datos para dar de baja la póliza |
Request body - instance of TerminateInsuranceRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| policyNumber | string | true | Número de póliza |
| reason | string | false | Motivo de la baja |
| document | string | false | Documento del asegurado |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The operation request was successfully accepted, returned the request external reference identifier | ProcessResponse |
| 400 | Bad Request | Error en los datos de la solicitud | None |
| 500 | Internal Server Error | Error interno del servidor | None |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Request-Correlation-Id | header | string | true | Unique request identifier |
| organization | path | string | true | Identificador único de la organización |
| phoneNumber | query | string | false | Teléfono asociado a la póliza (opcional) |
| document | query | string | false | Documento del asegurado (opcional) |
| policyNumber | query | string | false | Número de póliza (opcional) |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Order created | [InsuranceInfoResponseDTO] |
| 400 | Bad Request | Error en los parámetros de consulta | None |
| 404 | Not Found | Póliza no encontrada | None |
| 500 | Internal Server Error | Error interno del servidor | None |
200 - instance of InsuranceInfoResponseDTO
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| certificateNumber | string | false | none |
| imei | string | false | none |
| brand | NameDTO | false | none |
| model | DescriptionDTO | false | none |
| phoneNumber | string | false | none |
| document | string | false | none |
| firstName | string | false | none |
| lastName1 | string | false | none |
| lastName2 | string | false | none |
| address | string | false | none |
| number | string | false | none |
| city | string | false | none |
| zipCode | string | false | none |
| policyNumber | string | false | none |
| province | string | false | none |
| effectiveDate | string | false | none |
| string | false | none | |
| sold | boolean | false | none |
| cancelled | boolean | false | none |
| cancellationDate | string | false | none |
| serialNumber | string | false | none |
| paymentMethod | DescriptionDTO | false | none |
| clientType | NameDTO | false | none |
| billPayment | boolean | false | none |
| withdrawal | boolean | false | none |
| withdrawalDate | string | false | none |
| emitted | boolean | false | none |
| language | NameDTO | false | none |
| accident | boolean | false | none |
Endpoints
Disney Tv
Netflix Tv
HBO Tv
Insurance Device