Pricing API

This API is used for policy pricing, creation and resolution.

You should have received a partner-specific URL and credentials to use this API. If you didn't, please contact our support team to set up the required services and credentials.

Get information about this instance

OPTIONS/api/v0/example

Response

200

Successful operation

Body

application/json

risk_modulestring

Example: "0x79D1cA16Cf39367f9d7A66974ee2627f45857029"

signerstring

Example: "0x79D1cA16Cf39367f9d7A66974ee2627f45857029"

decimalsinteger

Example: 6

topicstring

Example: "dynamic-pricing"

Request

JavaScriptCurl

const response = await fetch('/api/v0/example', {
    method: 'OPTIONS',
    headers: {},
});
const data = await response.json();

Response

{
  "risk_module": "0x79D1cA16Cf39367f9d7A66974ee2627f45857029",
  "signer": "0x79D1cA16Cf39367f9d7A66974ee2627f45857029",
  "decimals": 6,
  "topic": "dynamic-pricing"
}

Create a new quote

POST/api/v0/example/quote

Authorization

api_key_header

Query parameters

Body

application/json

Quote parameters

dataobject

expirationstring (date-time)

Example: "2022-10-27T21:36:07.211025Z"

payoutstring

Example: "190.25"

Response

200400

Successful operation

Body

application/json

quote_idstring

Quote unique identifier, used across Ensuro's APIs

Example: "c06bec3e-6984-49d8-a866-b27e0cbf1f4d"

data_hashstring

Hash that uniquely identifies this policy

Example: "0x0a39ddc02112fd46bdd9be79f4e13f558aaf9ce02467e4b6ea7ee8a896f89008"

loss_probstring

Loss probability for the policy, 0 < loss_prob < 1

Example: "0.105"

premiumstring

The premium that must be sent to the contract. If null send MAX_UINT256

Example: "19.9"

bucket_idstring

[optional] Pricing bucket id, only if the riskmodule is a SignedBucketRiskModule

Example: "Bucket1"

signatureSignature (object)

valid_untilinteger

Quote expiration as seconds since epoch

Example: 1665447869

Request

JavaScriptCurl

const response = await fetch('/api/v0/example/quote', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "quote_id": "c06bec3e-6984-49d8-a866-b27e0cbf1f4d",
  "data_hash": "0x0a39ddc02112fd46bdd9be79f4e13f558aaf9ce02467e4b6ea7ee8a896f89008",
  "loss_prob": "0.105",
  "premium": "19.9",
  "bucket_id": "Bucket1",
  "signature": {
    "hash": "0x655daa61a6cf9d65d07329ec011c22650a05b526fb41c9b1683956e7b241a2bf",
    "r": "0xfa77cd0f2d12287d1d9e0ef367e411e8d02f59890c2977f5bdc3f1dbf30aab54",
    "vs": "0x50d6f317112b224daf7efc73ac4f294358314fe53d423a672d56844c4d6843e9"
  },
  "valid_until": 1665447869
}

Create a new policy

POST/api/v0/example/new-policy

Authorization

api_key_header

Header parameters

Body

application/json

Policy parameters

dataobject

expirationstring (date-time)

Example: "2022-10-27T21:36:07.211025Z"

payoutstring

Example: "190.25"

Response

200400

Successful operation

Body

application/json

quote_idstring

Quote unique identifier, used across Ensuro's APIs

Example: "c06bec3e-6984-49d8-a866-b27e0cbf1f4d"

data_hashstring

Hash that uniquely identifies this policy

Example: "0x0a39ddc02112fd46bdd9be79f4e13f558aaf9ce02467e4b6ea7ee8a896f89008"

loss_probstring

Loss probability for the policy, 0 < loss_prob < 1

Example: "0.105"

premiumstring

The premium that must be sent to the contract. If null send MAX_UINT256

Example: "19.9"

bucket_idstring

[optional] Pricing bucket id, only if the riskmodule is a SignedBucketRiskModule

Example: "Bucket1"

signatureSignature (object)

valid_untilinteger

Quote expiration as seconds since epoch

Example: 1665447869

Request

JavaScriptCurl

const response = await fetch('/api/v0/example/new-policy', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "quote_id": "c06bec3e-6984-49d8-a866-b27e0cbf1f4d",
  "data_hash": "0x0a39ddc02112fd46bdd9be79f4e13f558aaf9ce02467e4b6ea7ee8a896f89008",
  "loss_prob": "0.105",
  "premium": "19.9",
  "bucket_id": "Bucket1",
  "signature": {
    "hash": "0x655daa61a6cf9d65d07329ec011c22650a05b526fb41c9b1683956e7b241a2bf",
    "r": "0xfa77cd0f2d12287d1d9e0ef367e411e8d02f59890c2977f5bdc3f1dbf30aab54",
    "vs": "0x50d6f317112b224daf7efc73ac4f294358314fe53d423a672d56844c4d6843e9"
  },
  "valid_until": 1665447869
}

Resolve a policy

POST/api/v0/example/resolve-policy

Authorization

api_key_header

Header parameters

Body

application/json

Policy resolution

ensuro_idstring

Example: "55290711940124341656440444382658655728151858290209621141129482339851750871896"

payoutstring

Example: "105.25"

Response

200400

Successful operation

Body

application/json

statusstring

Example: "QUEUED"

Request

JavaScriptCurl

const response = await fetch('/api/v0/example/resolve-policy', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": "QUEUED"
}

Replace a policy

POST/api/v0/example/replace-policy

Authorization

api_key_header

Header parameters

Body

application/json

Replacement parameters

dataobject

expirationstring (date-time)

Example: "2022-10-27T21:36:07.211025Z"

payoutstring

Example: "190.25"

old_ensuro_id*string

Example: "55290711940124341656440444382658655728151858290209621141129482339851750871896"

Response

200400

Successful operation

Body

application/json

quote_idstring

Quote unique identifier, used across Ensuro's APIs

Example: "c06bec3e-6984-49d8-a866-b27e0cbf1f4d"

data_hashstring

Hash that uniquely identifies this policy

Example: "0x0a39ddc02112fd46bdd9be79f4e13f558aaf9ce02467e4b6ea7ee8a896f89008"

loss_probstring

Loss probability for the policy, 0 < loss_prob < 1

Example: "0.105"

premiumstring

The premium that must be sent to the contract. If null send MAX_UINT256

Example: "19.9"

bucket_idstring

[optional] Pricing bucket id, only if the riskmodule is a SignedBucketRiskModule

Example: "Bucket1"

signatureSignature (object)

valid_untilinteger

Quote expiration as seconds since epoch

Example: 1665447869

Request

JavaScriptCurl

const response = await fetch('/api/v0/example/replace-policy', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "old_ensuro_id": "55290711940124341656440444382658655728151858290209621141129482339851750871896"
    }),
});
const data = await response.json();

Response

{
  "quote_id": "c06bec3e-6984-49d8-a866-b27e0cbf1f4d",
  "data_hash": "0x0a39ddc02112fd46bdd9be79f4e13f558aaf9ce02467e4b6ea7ee8a896f89008",
  "loss_prob": "0.105",
  "premium": "19.9",
  "bucket_id": "Bucket1",
  "signature": {
    "hash": "0x655daa61a6cf9d65d07329ec011c22650a05b526fb41c9b1683956e7b241a2bf",
    "r": "0xfa77cd0f2d12287d1d9e0ef367e411e8d02f59890c2977f5bdc3f1dbf30aab54",
    "vs": "0x50d6f317112b224daf7efc73ac4f294358314fe53d423a672d56844c4d6843e9"
  },
  "valid_until": 1665447869
}

Signatures

For policy creation and resolution the body of the request must be signed.

There's two options available for signing:

• Symmetric: a shared secret will be provided and it has to be used to compute an hmac digest. The digest must be sent in the X-Ensuro-Signature of the request.

• Asymmetric: An authorized ethereum account is used to sign the body of the message. This method is safer because only the partner has access to the private key and it does not need to be sent over the internet ever. The signature is computed following the EIP191 standard. It must be sent in the X-EIP191-Signature header of the request.

Only one of the methods must be used, and "Asymmetric" is the preferred one.

See our samples repository for a js example of how to use each one.