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: broker1

Broker ID

bsecret
required
string
Example: test1234

Broker Secret

Request Body schema: application/json
prodid
required
string

Product ID [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

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

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

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

innik
string

Insured ID No

inrelation
string

Insured Relation

name1
string

Beneficary Name 1

dob1
string

Beneficary Date of Birth 1

nik1
string

Beneficary No ID 1

relation1
string

Beneficary Relation 1

val1
int

Beneficary Value 1

name2
string

Beneficary Name 2

dob2
string

Beneficary Date of Birth 2

nik2
string

Beneficary No ID 2

relation2
string

Beneficary Relation 2

val2
int

Beneficary Value 2

name3
string

Beneficary Name 3

dob3
string

Beneficary Date of Birth 3

nik3
string

Beneficary No ID 3

relation3
string

Beneficary Relation 3

val3
int

Beneficary Value 3

name4
string

Beneficary Name 4

dob4
string

Beneficary Date of Birth 4

nik4
string

Beneficary No ID 4

relation4
string

Beneficary Relation 4

val4
int

Beneficary Value 4

name5
string

Beneficary Name 5

dob5
string

Beneficary Date of Birth 5

nik5
string

Beneficary No ID 5

relation5
string

Beneficary Relation 5

val5
int

Beneficary Value 5

suminsured
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]

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": "ACTD",
  • "phname": "budi",
  • "phdob": "1993-01-01",
  • "phgender": "M",
  • "phnik": "3218728xxxxx1000",
  • "phaddress": "Jl. Setia Budi",
  • "phcity": "DKI Jakarta",
  • "phpostalcode": "12940",
  • "phphoneno": "0821xxxx0011",
  • "phemail": "[email protected]",
  • "inname": "Lesti",
  • "indob": "1997-01-01",
  • "ingender": "F",
  • "innik": "3218322xxxxx1001",
  • "inrelation": "Pasangan wanita",
  • "name1": "",
  • "dob1": "",
  • "nik1": "",
  • "relation1": "",
  • "val1": 0,
  • "name2": "",
  • "dob2": "",
  • "nik2": "",
  • "relation2": "",
  • "val2": 0,
  • "name3": "",
  • "dob3": "",
  • "nik3": "",
  • "relation3": "",
  • "val3": 0,
  • "name4": "",
  • "dob4": "",
  • "nik4": "",
  • "relation4": "",
  • "val4": 0,
  • "name5": "",
  • "dob5": "",
  • "nik5": "",
  • "relation5": "",
  • "val5": 0,
  • "suminsured": 50000000,
  • "freq": "M",
  • "coverage": 10,
  • "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"
}