Ciputra Life - API Documentation (2.0.0)

Download OpenAPI specification:Download

Ciputra Life - API Documentation E-Simulation.

create-simulation

Create Simulation

Create Simulation

header Parameters
bid
required
string
Example: xxxx

Broker ID

bsecret
required
string
Example: xxxx

Broker Secret

Request Body schema: application/json
prodid
required
string

Product ID [CJKD: Ciputra Jaminan Kecelakaan Diri, SP: Ciputra Life-Saver, ABC: Asuransi Beasiswa Ciputra, ACTD: Asuransi Ciputra Target Dana]

phname
required
string

Policy Holder Name

phdob
required
string

Policy Holder Date of Birth

phage
string

Enter age of policyholder (if not filled in, age will be taken from date of birth)

phgender
string
Enum: "M" "F" "N"

Policy Holder Gender [M: Male, F: Female, N: None]

phnik
string

Policy Holder No ID

phaddress
string

Policy Holder Address

phcity
string

Policy Holder City

phpostalcode
string

Policy Holder Postal Code

phphoneno
string

Policy Holder Phone No

phemail
string <email>

Policy Holder Email

inname
string

Insured Name

indob
string

Insured Date of Birth

inage
string

Enter age of insured (if not filled in, age will be taken from date of birth)

ingender
string
Enum: "M" "F" "N"

Insured Gender [M: Male, F: Female, N: None]

innik
string

Insured ID No

inrelation
string

Insured Relation

suminsured
int

Sum Insured

freq
required
string
Value: "L"

Payment Frequency [L: Lump Sum ]

typeview
required
int
Enum: 1 2 3 4 5 6 7 8

Type View [1: Snap, 2: Preview, 3: Page of..., 4: Preview PDF, 5: Download PDF, 6: Data Raw, 7: PDF Base64, 8: Download Attachment Page]

page
int
Enum: 0 1 2 3 4 5 6

typeview = 3: Page of ...[0: default]

exp_date
string

exp_date is used to determine the simulation expiration date. if the exp_date is not filled, it will automatically follow the simulation of the expired date that has been specified in the product setup

Responses

Request samples

Content type
application/json
Example
{
  • "prodid": "CJKD",
  • "phname": "budi",
  • "phdob": "1993-01-01",
  • "phage": "",
  • "phgender": "M",
  • "phnik": "3218728xxxxx1000",
  • "phaddress": "Jl. Setia Budi",
  • "phcity": "DKI Jakarta",
  • "phpostalcode": "12940",
  • "phphoneno": "0821xxxx0011",
  • "phemail": "[email protected]",
  • "inname": "Lesti",
  • "indob": "1997-01-01",
  • "inage": "",
  • "ingender": "F",
  • "innik": "3218322xxxxx1001",
  • "inrelation": "Pasangan",
  • "suminsured": 50000000,
  • "freq": "L",
  • "typeview": 3,
  • "page": 3,
  • "exp_date": "2022-05-22"
}

Response samples

Content type
application/json
{}

simulation

Simulation

Simulation

API Send and Inquiry Simulation

header Parameters
bid
required
string
Example: broker1

Broker ID

bsecret
required
string
Example: test1234

Broker Secret

Request Body schema: application/json
action
required
string

Action api [inquiry, send, and download]

request_id
required
string

Request ID

Responses

Request samples

Content type
application/json
Example
{
  • "action": "inquiry",
  • "request_id": "DBB1807091513"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": {
    }
}

calculate

Calculate

Calculate

API Calculate Simulation

header Parameters
bid
required
string
Example: broker1

Broker ID

bsecret
required
string
Example: test1234

Broker Secret

Request Body schema: application/json
prodid
string

Product ID [ACTD: Asuransi Ciputra Target Dana, ABC: Asuransi Beasiswa Ciputra]

inname
required
string

Insured Name

indob
required
string

Insured Date of Birth

ingender
required
string
Enum: "M" "F" "N"

Insured Gender [M: Male, F: Female, N: None]

suminsured
required
int

Sum Insured

freq
required
string
Enum: "M" "Q" "S" "A"

Payment Frequency [M: Month, Q: quarterly, S: semester, A: Annual ]

coverage
required
int

Coverage [10 - 50]

Responses

Request samples

Content type
application/json
Example
{
  • "prodid": "ACTD",
  • "inname": "Lesti",
  • "indob": "1997-01-01",
  • "ingender": "F",
  • "suminsured": 50000000,
  • "freq": "M",
  • "coverage": 10
}

Response samples

Content type
application/json
{
  • "status": true,
  • "code": "00",
  • "data": {
    },
  • "messages": "success"
}