Skip to content

Ledger/Sales service (1.0)

Using Swagger documentation in Postman


You can find instructions on how to convert swagger documentation to Postman collection here.
There is a known problem in Postman with env variables being imported as parameters (:schemaName instead of {{schemaName}}. More info on the issue can be found here.
Possible workaround is to find and replace all parameters with env variables inside Postman. For example search for :schemaName and replace with {{schemaName}}. Instructions how to do it in Postman are here.

Authorization

To obtain a token, start by visiting the identifier service documentation and make a request with your username and password.
Once you receive the response, copy the access_token and use it for making requests to ledger services.
Download OpenAPI description
Languages
Servers
Mock server

https://ledger.docs.insly.com/_mock/apis/ledger/bundled/

Beta

https://ledger.app.beta.insly.training/

Demo

https://ledger.app.demo.insly.com/

Operations

Request

Create a new quote by schema, you can get schema in Schemes section

Security
bearerAuth
Headers
X-TENANT-IDstringrequired

Tenant tag

Example: {$inputs.tenant}
Accept-Languagestringrequired

Chosen language

Bodyapplication/json

Full request structure per product can be taken from json scheme Product json scheme. with type: policy and name: {name of the insurance product}.

any
curl -i -X POST \
  https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/sales/policies/create \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-TENANT-ID: {$inputs.tenant}' \
  -d '{}'

Responses

Full request structure per product can be taken from json scheme Product json scheme. with type: policy and name: {name of the insurance product}.

Bodyapplication/json
any
Response
application/json
[]

Request

Security
bearerAuth
Headers
X-TENANT-IDstringrequired

Tenant tag

Example: {$inputs.tenant}
Accept-Languagestringrequired

Chosen language

Bodyapplication/json

Full request structure per product can be taken from json scheme Product json scheme. with type: policy and name: {name of the insurance product}.

any
curl -i -X POST \
  https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/sales/policies/mta \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-TENANT-ID: {$inputs.tenant}' \
  -d '[
    "See request description for more details."
  ]'

Responses

Creates policy mta

Bodyapplication/json
policyobject(policy)
policy.​idinteger
Example: "1234"
policy.​policyNostring
policy.​dateIssuestring(date)
policy.​dateInceptionstring(date)
policy.​dateExpirystring(date)
policy.​financialsobject(financials-policy)
policy.​financials.​installmentsnumber
policy.​financials.​adminFeeSumnumber
policy.​financials.​feeVatPctnumber
policy.​paramsobject(params)
policy.​params.​attribute1string
policy.​params.​attribute2string
policy.​params.​attribute...string
policy.​params.​attribute45string
customerobject(customer)
customer.​namestring
customer.​codestring
customer.​paramsobject(params)
customer.​params.​attribute1string
customer.​params.​attribute2string
customer.​params.​attribute...string
customer.​params.​attribute45string
agentobject(agent)
agent.​brokerstring
agent.​codestring
agent.​paramsobject(params)
agent.​params.​attribute1string
agent.​params.​attribute2string
agent.​params.​attribute...string
agent.​params.​attribute45string
objectsobject(object)
objects.​objectIdobject(objectData)
objects.​objectId.​dataArray of objects(object-data)
objects.​objectId.​productsArray of objects(object-products)
Response
application/json
{ "policy": { "id": "1234", "policyNo": "string", "dateIssue": "2019-08-24", "dateInception": "2019-08-24", "dateExpiry": "2019-08-24", "financials": { … }, "params": { … } }, "customer": { "name": "string", "code": "string", "params": { … } }, "agent": { "broker": "string", "code": "string", "params": { … } }, "objects": { "objectId": { … } } }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations