# API Integration Document

Version 4.1 - API Driven Microservices Platform

## SSL and Token Based Dual Authentication

Becoming a fairly straight forward process:

```
{
"status": "SUCCESS",
"errorcode": "0000",
"data": {
"sessionId": "v22raa1fo7u9tmds5j0etop370",
"token": "142a55a47ddd954cc084154548db0f8d"
},
"message": null,
"errors": null
}
```

{% hint style="info" %}
 Sample are granted randomly so please submit an issue if required.
{% endhint %}


# Eiger Token API

## Authentication

<mark style="color:blue;">`GET`</mark> `https://{baseurl}/eiger/api/login`

This endpoint allows you to validate user name and password to get token valid for certain time.

#### Headers

| Name                   | Type   | Description                               |
| ---------------------- | ------ | ----------------------------------------- |
| EIGER-AUTH-USERNAME    | string | Web Service Access User Name and Password |
| EIGER-AUTH-PASSWORD    | string | Web Service Access User Name and Password |
| EIGER-API-REQUEST-TYPE | string | REST                                      |
| Accept                 | string | application/json                          |
| Content-Type           | string | application/json                          |

{% tabs %}
{% tab title="200 Token successfully retrieved." %}

```
{
"status": "SUCCESS",
"errorcode": "0000",
"data": {
"sessionId": "v22raa1fo7u9tmds5j0etop370",
"token": "142a55a47ddd954cc084154548db0f8d"
},
"message": null,
"errors": null
}
```

{% endtab %}

{% tab title="404 Failed." %}

```
{    "message": "Failed"}
```

{% endtab %}
{% endtabs %}


# Sale API

Web service for create sales request

## Register

<mark style="color:green;">`POST`</mark> `https://{baseurl}/sales/sale/api/register`

This endpoint allows you to create sales request.

#### Query Parameters

| Name                    | Type   | Description                         |
| ----------------------- | ------ | ----------------------------------- |
| country                 | string | Country Code                        |
| partner\_code           | string | Partner Code                        |
| plan\_code              | string | Plan Code                           |
| partner\_reference      | string | Partner Reference Number            |
| name                    | string | Customer Name                       |
| mobile                  | string | Customer Mobile                     |
| id\_type                | string | Customer Id Type                    |
| id\_number              | string | Customer Id Number                  |
| email                   | string | Customer Email                      |
| dob                     | string | Customer Date of Birth (YYYY-MM-DD) |
| sale\_date              | string | Sale Date (YYYY-MM-DD)              |
| beneficiaryName         | string | Beneficiary Name                    |
| beneficiaryRelationship | string | Beneficiary Relationship            |
| beneficiaryIdType       | string | Beneficiary National Id Type        |
| beneficiaryidNumber     | string | Beneficiary Id Number               |
| beneficiaryFatherName   | string | Beneficiary Father Name             |
| notes                   | array  | Other Useful Information            |

#### Headers

| Name                   | Type   | Description                          |
| ---------------------- | ------ | ------------------------------------ |
| EIGER-SESSION-ID       | string | Webservice Token API Generated Value |
| EIGER-TOKEN            | string | Webservice Token API Generated Value |
| EIGER-API-REQUEST-TYPE | string | REST                                 |
| Accept                 | string | application/json                     |
| Content-Type           | string | application/json                     |

{% tabs %}
{% tab title="200 Sale successfully registered." %}

```
{
"status": "SUCCESS",
"errorcode": "0000",
"data": {
"apiType": "Create Sale API",
"sale_number": "SC.XXXX.20.0000000062.00",
"certificate_start_date": "2020-01-25",
"certificate_end_date": "2030-11-08"
},
"message": "Sales registered successfully",
"errors": null
}
```

{% endtab %}

{% tab title="404 Failed to register sale." %}

```
{    "message": "Failed"}
```

{% endtab %}
{% endtabs %}


# Sale Status Update API

Eiger web service for Sale Status Update

## SaleStatusUpdate

<mark style="color:green;">`POST`</mark> `https://{baseurl}/sales/sale/api/saleStatus`

This endpoint allows you to get free cakes.

#### Query Parameters

| Name          | Type    | Description                             |
| ------------- | ------- | --------------------------------------- |
| country       | string  | Country Code                            |
| partner\_code | string  | Partner Code                            |
| sale\_id      | string  | Sale Id                                 |
| status        | boolean | Status 1- Active 2- Expired 3 Suspended |

#### Headers

| Name                   | Type   | Description                       |
| ---------------------- | ------ | --------------------------------- |
| EIGER-SESSION-ID       | string | Web Service Generated Token Value |
| EIGER-TOKEN            | string | Web Service Generated Token Value |
| EIGER-API-REQUEST-TYPE | string | REST                              |
| Accept                 | string | application/json                  |
| Content-Type           | string | application/json                  |

{% tabs %}
{% tab title="200 Sale Status Updated successfully." %}

```
{
"status": "SUCCESS",
"errorcode": "0000",
"message": "Sales Status Updated Successfully",
"errors": null
}
```

{% endtab %}

{% tab title="404 Failed." %}

```
{    "message": "Failed"}
```

{% endtab %}
{% endtabs %}


# Claim Registration API

Eiger web service for Register Claim

## ClaimRegister

<mark style="color:green;">`POST`</mark> `https://{baseurl}/claims/claim/api/register`

This endpoint allows you to register customer claim.

#### Query Parameters

| Name                | Type   | Description                                                                                                                                                       |
| ------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Claim Flag          | string | <p>Claim Flag <br>1- Open <br>2- Closed</p>                                                                                                                       |
| sale\_id            | string | Sale Id Generated from Sale Registration API                                                                                                                      |
| claim\_date         | string | Claim Date (YYYY-MM-DD)                                                                                                                                           |
| claim\_status       | string | <p>Claim Status are as follwoing<br>1- Registered <br>2- Processing <br>3- Documents Completed <br>4- Approved <br>5- Denied <br>6- Under Payment <br>7- Paid</p> |
| coverage\_name      | string | Coverage Name                                                                                                                                                     |
| claim\_type         | string | Claim Type                                                                                                                                                        |
| incident\_startdate | string | Incident Start Date ( YYYY-MM-DD )                                                                                                                                |
| incident\_enddate   | string | Incident End Date ( YYYY-MM-DD)                                                                                                                                   |
| incident\_reason    | string | Incident Reason                                                                                                                                                   |
| type\_of\_provider  | string | <p>Type of Provider <br>1- Insurance Company <br>2- Hospital & Clinic <br>3- Pharmacies <br>4- Repair Network <br>5- Others</p>                                   |
| customer\_complaint | string | Customer Compaint Description.                                                                                                                                    |
| notes               | array  | Other Usefull Information.                                                                                                                                        |

#### Headers

| Name                   | Type   | Description                           |
| ---------------------- | ------ | ------------------------------------- |
| EIGER-SESSION-ID       | string | Web Service Token API Generated Value |
| EIGER-TOKEN            | string | Web Service Token API Generated Value |
| EIGER-API-REQUEST-TYPE | string | REST                                  |
| Accept                 | string | application/json                      |
| Content-Type           | string | application/json                      |

{% tabs %}
{% tab title="200 Claim Registered Sucessfully." %}

```
{
"status": "SUCCESS",
"errorcode": "0000",
"claim_reference_number": "XXXXXXXXXX",
"message": "Claim Registered Successfully",
"errors": null
}
```

{% endtab %}

{% tab title="404 Failed." %}

```
{    "message": "Failed."}
```

{% endtab %}
{% endtabs %}


# Claim Status Update API

Eiger web service for Claim Status Update

## ClaimStatusUpdate

<mark style="color:green;">`POST`</mark> `https://{baseurl}/claims/claim/api/statusUpdate`

This endpoint allows you to update claim status.

#### Query Parameters

| Name                     | Type    | Description                                                                                                                                                    |
| ------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| claim\_reference\_number | string  | Claim Reference Number                                                                                                                                         |
| claim Status             | string  | <p>Claim Status are as following.<br>1- Registered <br>2- Processing <br>3- Documents Completed <br>4- Approved 5- Denied <br>6- Under Payment <br>7- Paid</p> |
| claim\_flag              | boolean | <p>Claim Flag <br>1- Open <br>2- Closed</p>                                                                                                                    |

#### Headers

| Name                   | Type   | Description                           |
| ---------------------- | ------ | ------------------------------------- |
| EIGER-SESSION-ID       | string | Web Service Token API Generated Value |
| EIGER-TOKEN            | string | Web Service Token API Generated Value |
| EIGER-API-REQUEST-TYPE | string | REST                                  |
| Accept                 | string | application/json                      |
| Content-Type           | string | application/json                      |

{% tabs %}
{% tab title="200 Claim Updated successfully." %}

```
{
"status": "SUCCESS",
"errorcode": "0000",
"message": "Claim Updated Successfully",
"errors": null
}
```

{% endtab %}

{% tab title="404 Failed." %}

```
{    "message": "Failed."}
```

{% endtab %}
{% endtabs %}


# Customer Registration API

Eiger web service for Customer Registration Request

## CustomerRegister

<mark style="color:green;">`POST`</mark> `https://{baseurl}/customers/customer/api/register`

This endpoint allows you to register customer.

#### Query Parameters

| Name       | Type    | Description            |
| ---------- | ------- | ---------------------- |
| name       | string  | Customer Name          |
| mobile     | string  | Customer Mobile Number |
| id\_number | string  | Customer any Id Number |
| email      | string  | Customer Email address |
| dob        | boolean | Customer Date of Birth |

#### Headers

| Name                   | Type   | Description                           |
| ---------------------- | ------ | ------------------------------------- |
| EIGER-SESSION-ID       | string | Web Service Token API Generated Value |
| EIGER-TOKEN            | string | Web Service Token API Generated Value |
| EIGER-API-REQUEST-TYPE | string | REST                                  |
| Accept                 | string | application/json                      |
| Content-Type           | string | application/json                      |

{% tabs %}
{% tab title="200 Customer successfully registered." %}

```
{
"status": "SUCCESS",
"errorcode": "0000",
"message": "Customer Registered Successfully",
"errors": null
}
```

{% endtab %}

{% tab title="404 Could not find a matching this query." %}

```
{    "message": "Failed"}
```

{% endtab %}
{% endtabs %}


# Customer Verification API

Eiger web service for Customer Validation Request

## CustomerValidate

<mark style="color:green;">`POST`</mark> `https://{baseurl}/customers/customer/api/validate`

This endpoint allows you to do customer details verification.

#### Query Parameters

| Name       | Type    | Description            |
| ---------- | ------- | ---------------------- |
| country    | string  | Country                |
| partner    | string  | Partner Name           |
| name       | string  | Customer Name          |
| mobile     | string  | Customer Mobile Number |
| Id\_number | string  | Customer ID Number     |
| email      | string  | Customer Email address |
| dob        | boolean | Customer Date of Birth |

#### Headers

| Name                   | Type   | Description                           |
| ---------------------- | ------ | ------------------------------------- |
| EIGER-SESSION-ID       | string | Web Service Token API Generated Value |
| EIGER-TOKEN            | string | Web Service Token API Generated Value |
| EIGER-API-REQUEST-TYPE | string | REST                                  |
| Accept                 | string | application/json                      |
| Content-Type           | string | application/json                      |

{% tabs %}
{% tab title="200 Customer successfully retrieved." %}

```
{
"status": "SUCCESS",
"requestType": "XXXXXXXXXXXXX",
"name": "XXXXXXXXXXXXX",
"mobile": "XXXXXXXXXXXXX",
"idnumber": "XXXXXXXXXXXXX",
"email": "XXXXXXXXXXXXX",
"dob": "XXXXXXXXXXXXX",
"validated_name": "XXXXXXXXXXXXX",
"validated_customerId": "XXXXXXXXXXXXX",
"message": "Success",
"errors": null
}
```

{% endtab %}

{% tab title="404 Could not find a matching this query." %}

```
{    "message": "Failed."}
```

{% endtab %}
{% endtabs %}


# Lead Registration API

Eiger web service for Lead Registration Request

## LeadRegister

<mark style="color:green;">`POST`</mark> `https://{baseurl}/leads/lead/api/register`

This endpoint allows you to register lead.

#### Query Parameters

| Name                       | Type   | Description                |
| -------------------------- | ------ | -------------------------- |
| country                    | string | Country                    |
| partner                    | string | Partner Name               |
| source                     | string | Lead Source                |
| status                     | string | Lead Status                |
| partner\_reference\_number | string | Partner Reference Number   |
| name                       | string | Lead Name                  |
| mobile                     | string | Lead Mobile Number         |
| id\_type                   | string | Lead ID Type               |
| id\_number                 | string | Lead Id Number             |
| email                      | string | Lead Email Address         |
| dob                        | string | Lead Date of Birth         |
| beneficiaryName            | string | Beneficiary Name           |
| beneficiaryRelationship    | string | Beneficiary Relationship   |
| beneficiaryIdType          | string | Beneficiary Id Type        |
| beneficiaryidNumber        | string | Beneficiary id Number      |
| beneficiaryFatherName      | string | Beneficiary Father’s Name. |

#### Headers

| Name                   | Type   | Description                           |
| ---------------------- | ------ | ------------------------------------- |
| EIGER-SESSION-ID       | string | Web Service Token API Generated Value |
| EIGER-TOKEN            | string | Web Service Token API Generated Value |
| EIGER-API-REQUEST-TYPE | string | REST                                  |
| Accept                 | string | application/json                      |
| Content-Type           | string | application/json                      |

{% tabs %}
{% tab title="200 Lead successfully registered." %}

```
{
"status": "SUCCESS",
"partner_reference_number": "XXXXXXXXXXXXX",
"name": "XXXXXXXXXXXXX",
"mobile": "XXXXXXXXXXXXX",
"idnumber": "XXXXXXXXXXXXX",
"email": "XXXXXXXXXXXXX",
"dob": "XXXXXXXXXXXXX",
"validated_name": "XXXXXXXXXXXXX",
"validated_customerId": "XXXXXXXXXXXXX",
"message": "Lead Registered Successfully",
"errors": null
}
```

{% endtab %}

{% tab title="404 Could not find a matching this query." %}

```
{    "message": "Failed"}
```

{% endtab %}
{% endtabs %}


# Coverage Status API

Eiger web service for customer policy coverage status

## CoverageStatus

<mark style="color:blue;">`GET`</mark> `https://{baseurl}/customers/customer/api/coverage`

This endpoint allows you to get customer policy coverage status.

#### Query Parameters

| Name         | Type    | Description   |
| ------------ | ------- | ------------- |
| country      | string  | Customer Name |
| partner      | string  | Partner Name  |
| customer\_id | string  | Customer id   |
| plan\_code   | boolean | PlanCode      |

#### Headers

| Name                   | Type   | Description                           |
| ---------------------- | ------ | ------------------------------------- |
| EIGER-SESSION-ID       | string | Web Service Token API Generated Value |
| EIGER-TOKEN            | string | Web Service Token API Generated Value |
| EIGER-API-REQUEST-TYPE | string | REST                                  |
| Accept                 | string | application/json                      |
| Content-Type           | string | application/json                      |

{% tabs %}
{% tab title="200 Claim Updated successfully." %}

```
{
"status": "SUCCESS",
"errorcode": "0000",
"coverage_status": "Active",
"message": "Claim Updated Successfully",
"errors": null
}
```

{% endtab %}

{% tab title="404 Could not find matching this query." %}

```
{    "message": "Failed"}
```

{% endtab %}
{% endtabs %}


# Plan Subscription API

Eiger web service for customer subscribed plans

## PlanSubscription

<mark style="color:green;">`POST`</mark> `https://{baseurl}/customres/customer/ap/sales`

This endpoint allows you to get customer subscribed plan details.

#### Query Parameters

| Name          | Type   | Description  |
| ------------- | ------ | ------------ |
| country       | string | Country Name |
| partner\_code | string | Partner Code |
| customer\_id  | string | Customer id  |
| plan\_code    | string | Plan Code    |

#### Headers

| Name                   | Type   | Description                           |
| ---------------------- | ------ | ------------------------------------- |
| EIGER-SESSION-ID       | string | Web Service Token API Generated Value |
| EIGER-TOKEN            | string | Web Service Token API Generated Value |
| EIGER-API-REQUEST-TYPE | string | REST                                  |
| Accept                 | string | application/json                      |
| Content-Type           | string | application/json                      |

{% tabs %}
{% tab title="200 Cake successfully retrieved." %}

```
{
"status": "SUCCESS",
"requestType": "XXXXXXXXXXXXX",
"country": "XXXXXXXXXXXXX",
"partner": "XXXXXXXXXXXXX",
"plan_name": "XXXXXXXXXXXXX",
"certificate_start_date": "XXXXXXXXXXXXX",
"certificate_end_date": "XXXXXXXXXXXXX",
"coverage_status": "XXXXXXXXXXXXX",
"name": "XXXXXXXXXXXXX",
"mobile": "XXXXXXXXXXXXX",
"idnumber": "XXXXXXXXXXXXX",
"email": "XXXXXXXXXXXXX",
"dob": "XXXXXXXXXXXXX",
"message": "Success",
"errors": null
}
```

{% endtab %}

{% tab title="404 Could not find record matching this query." %}

```
{    "message": "Failed."}
```

{% endtab %}
{% endtabs %}


# List of Other Useful EIGER APIs

Eiger deployment architecture leverages the Kubernetes and docker architecture, and it’s a self-healing system.

**partner\_add**&#x20;

**partner\_edit**&#x20;

**partner\_delete**&#x20;

**partner\_list**&#x20;

**partner\_get**&#x20;

**lead\_add**&#x20;

**lead\_edit**&#x20;

**lead\_delete**&#x20;

**lead\_list**&#x20;

**lead\_billing\_add**&#x20;

**lead\_billing\_update**&#x20;

**lead\_billing\_delete**&#x20;

**lead\_billing\_list**&#x20;

**lead\_transaction\_add**&#x20;

**lead\_transaction\_edit**&#x20;

**lead\_transaction\_delete**&#x20;

**lead\_get plan\_add**&#x20;

**plan\_edit**&#x20;

**plan\_delete**&#x20;

**plan\_list**&#x20;

**plan\_get**&#x20;

**product\_add**&#x20;

**product\_edit**&#x20;

**product\_delete**&#x20;

**product\_list**&#x20;

**product\_get**&#x20;

**coverage\_add**&#x20;

**coverage\_edit**&#x20;

**coverage\_delete**&#x20;

**coverage\_list**&#x20;

**coverage\_get**&#x20;

**plan\_pricing\_add**&#x20;

**plan\_pricing\_edit**&#x20;

**plan\_pricing\_delete**&#x20;

**plan\_pricing\_list**&#x20;

**plan\_status\_handler**&#x20;

**plan\_import\_ms\_extractor**&#x20;

**plan\_import\_ms\_validator**&#x20;

**plan\_import\_ms\_import**&#x20;

**plan\_import\_ms\_error\_log\_lst**&#x20;

**customer\_add**&#x20;

**customer\_edit**&#x20;

**customer\_delete**&#x20;

**customer\_list**&#x20;

**customer\_documents\_add**&#x20;

**customer\_documents\_delete**&#x20;

**customer\_get customer\_import\_ms\_extractor**&#x20;

**customer\_import\_ms\_validator**&#x20;

**customer\_import\_ms\_import**&#x20;

**customer\_import\_ms\_error\_log\_list**&#x20;

**SaleimportsList\_ms**&#x20;

**sales\_import\_ms\_extractor**&#x20;

**sales\_import\_ms\_validator**&#x20;

**sales\_import\_ms\_import**&#x20;

**sales\_import\_ms\_error\_log\_list**&#x20;

**customercare\_customer\_search**&#x20;

**customercare\_claimdetails\_list**&#x20;

**customercare\_customer\_list**&#x20;

**customercare\_saledetails\_list**&#x20;

**customercare\_salecoverage\_list**&#x20;

**customercare\_salebilling\_add**&#x20;

**customercare\_salebilling\_delete**&#x20;

**customercare\_salebilling\_edit**&#x20;

**customercare\_salebilling\_get**&#x20;

**contact\_add**&#x20;

**contact\_edit**&#x20;

**contact\_delete**

**contact\_list**&#x20;

**provider\_add**&#x20;

**provider\_edit**&#x20;

**provider\_delete**&#x20;

**provider\_list**&#x20;

**provider\_get**&#x20;

**claim\_add\_claimbenefits**&#x20;

**claim\_add\_claimregistration**&#x20;

**claim\_add\_claimantinfo**&#x20;

**claim\_add\_claimdocuments**&#x20;

**claim\_add\_bankdetails**&#x20;

**claim\_edit\_claimbenefits**&#x20;

**claim\_edit\_claimregistration**&#x20;

**claim\_edit\_claimantinfo**&#x20;

**claim\_edit\_bankdetails**&#x20;

**claim\_get\_claimbenefits**&#x20;

**claim\_get\_claimregistration**&#x20;

**claim\_get\_claimantinfo**

**claim\_get\_bankdetails**&#x20;

**claim\_status\_handler**&#x20;

**claim\_flag\_handler**&#x20;

**claim\_event\_handler**&#x20;

**claim\_invoice\_add**&#x20;

**claim\_invoice\_edit**&#x20;

**claim\_invoice\_delete**&#x20;

**claim\_invoice\_list**&#x20;

**claim\_invoice\_status\_handler**&#x20;

**claim\_invoice\_counter\_handler**&#x20;

**claim\_invoice\_status\_handler**&#x20;

**claim\_invoice\_approval\_add**&#x20;

**claim\_invoice\_approval\_edit**&#x20;

**claim\_invoice\_approval\_list**&#x20;

**claim\_invoice\_clearence\_add**&#x20;

**claim\_invoice\_clearence\_edit**&#x20;

**claim\_invoice\_clearence\_delete**&#x20;

**claim\_invoice\_clearence\_list**&#x20;

**sms\_msg\_add**&#x20;

**sms\_msg\_edit**&#x20;

**sms\_msg\_list**&#x20;

**vendor\_add**&#x20;

**vendor\_edit**&#x20;

**vendor\_delete**&#x20;

**vendor\_list**&#x20;

**vendor\_get**&#x20;

**report\_salesreport\_get**&#x20;

**report\_generic\_get**&#x20;

**report\_lead\_get**&#x20;

**report\_qualificationreport\_get**&#x20;

**report\_insurancereport\_get**&#x20;

**product\_type\_add**&#x20;

**product\_type\_edit**&#x20;

**product\_type\_delete**&#x20;

**product\_type\_list**&#x20;

**product\_plan\_assignment**&#x20;

**eiger\_token\_api**&#x20;

**customer\_registration\_api**&#x20;

**customer\_verification\_api**&#x20;

**lead\_registration\_api**&#x20;

**sales\_registration\_api**&#x20;

**coverage\_status\_api**&#x20;

**customer\_plan\_subscriptions\_api**&#x20;

**errorcodes\_api**&#x20;

**logging\_tracking\_handler**&#x20;

**caching\_service\_handler**&#x20;

**model\_compare\_datetime\_validator**&#x20;

**model\_datetime\_defaultvalue\_validator**&#x20;

**modelnumber\_validator**&#x20;

**model\_readonly\_validator**&#x20;

**model\_required\_validator**&#x20;

**modeltype\_validator**&#x20;

**modelunique\_validator**&#x20;

**stringvalidator\_helper**&#x20;

**type\_validator**&#x20;

**exception\_handler**