Guarantees

Query parameters

page integer · optional

Page number of the guarantees list. Default: 1

limit integer · optional

The number of items to return per page. Default: 10

Responses

200 Success

application/json

totalItems number · optional

guarantees object · Guarantee[] · optional

details object · GuaranteeDetails · optional

policyNumber string · optional

actType string · enum · nullable · optional

Possible values: BAIL_ACT, POST_SALE, OTHER

checkCode string · nullable · optional

emittedAt string · date-time · nullable · optional

effectiveAt string · date-time · nullable · optional

expiresAt string · date-time · nullable · optional

isFixedExpiry boolean · nullable · optional

cig string · nullable · optional

batchCode string · nullable · optional

economics object · EconomicData · optional

garantedAmount number · nullable · optional

contractAmount number · nullable · optional

isAutomaticRenewal boolean · nullable · optional

note object · Note · optional

shared string · optional

Default: “”

sign object · Sign · optional

emissionAt string · date-time · nullable · optional

txHash string · nullable · optional

notarizationStatus string · enum · nullable · optional

Possible values: PENDING, COMPLETE

docs object · Doc[] · optional

type string · enum · optional

Possible values: BAIL_ACT, POST_SALE, OTHER

key string · optional

checksum string · nullable · optional

createdAt string · date-time · optional

Default: now

id string · optional

orgId string · optional

GET /api/v1/guarantees

GET /api/v1/guarantees HTTP/1.1
Accept: */*

curl -L \
  --url '/api/v1/guarantees' \
  --header 'Accept: */*'

const response = await fetch('/api/v1/guarantees', {
    method: 'GET',
    headers: {
      "Accept": "*/*"
    },
});

const data = await response.json();

import requests

response = requests.get(
    "/api/v1/guarantees",
    headers={"Accept":"*/*"},
)

data = response.json()

200 Success

{
  "totalItems": 1,
  "guarantees": [
    {
      "details": {
        "policyNumber": "text",
        "actType": "BAIL_ACT",
        "checkCode": "text",
        "emittedAt": "2026-07-29T14:09:16.886Z",
        "effectiveAt": "2026-07-29T14:09:16.886Z",
        "expiresAt": "2026-07-29T14:09:16.886Z",
        "isFixedExpiry": true,
        "cig": "text",
        "batchCode": "text"
      },
      "economics": {
        "garantedAmount": 1,
        "contractAmount": 1,
        "isAutomaticRenewal": true
      },
      "note": {
        "shared": ""
      },
      "sign": {
        "emissionAt": "2026-07-29T14:09:16.886Z"
      },
      "txHash": "text",
      "notarizationStatus": "PENDING",
      "docs": [
        {
          "type": "BAIL_ACT",
          "key": "text",
          "checksum": "text"
        }
      ],
      "createdAt": "now",
      "id": "text",
      "orgId": "text"
    }
  ]
}

Body application/json

details object · GuaranteeDetails · optional

policyNumber string · optional

actType string · enum · nullable · optional

Possible values: BAIL_ACT, POST_SALE, OTHER

checkCode string · nullable · optional

emittedAt string · date-time · nullable · optional

effectiveAt string · date-time · nullable · optional

expiresAt string · date-time · nullable · optional

isFixedExpiry boolean · nullable · optional

cig string · nullable · optional

batchCode string · nullable · optional

economics object · EconomicData · optional

garantedAmount number · nullable · optional

contractAmount number · nullable · optional

isAutomaticRenewal boolean · nullable · optional

note object · Note · optional

shared string · optional

Default: “”

sign object · Sign · optional

emissionAt string · date-time · nullable · optional

txHash string · nullable · optional

notarizationStatus string · enum · nullable · optional

Possible values: PENDING, COMPLETE

docs object · Doc[] · optional

type string · enum · optional

Possible values: BAIL_ACT, POST_SALE, OTHER

key string · optional

checksum string · nullable · optional

createdAt string · date-time · optional

Default: now

id string · optional

orgId string · optional

Responses

200 Successful operation

application/json

details object · GuaranteeDetails · optional

policyNumber string · optional

actType string · enum · nullable · optional

Possible values: BAIL_ACT, POST_SALE, OTHER

checkCode string · nullable · optional

emittedAt string · date-time · nullable · optional

effectiveAt string · date-time · nullable · optional

expiresAt string · date-time · nullable · optional

isFixedExpiry boolean · nullable · optional

cig string · nullable · optional

batchCode string · nullable · optional

economics object · EconomicData · optional

garantedAmount number · nullable · optional

contractAmount number · nullable · optional

isAutomaticRenewal boolean · nullable · optional

note object · Note · optional

shared string · nullable · optional

Default: “”

sign object · Sign · optional

emissionAt string · date-time · nullable · optional

txHash string · nullable · optional

notarizationStatus string · enum · nullable · optional

Possible values: PENDING, COMPLETE

docs object · Doc[] · optional

type string · enum · optional

Possible values: BAIL_ACT, POST_SALE, OTHER

key string · optional

checksum string · nullable · optional

createdAt string · date-time · optional

Default: now

id string · optional

orgId string · optional

400 Bad request

No content

401 Unauthorized

No content

500 Internal server error

No content

POST /api/v1/guarantees

POST /api/v1/guarantees HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 547

{
  "details": {
    "policyNumber": "text",
    "actType": "BAIL_ACT",
    "checkCode": "text",
    "emittedAt": "2026-07-29T14:37:24.692Z",
    "effectiveAt": "2026-07-29T14:37:24.692Z",
    "expiresAt": "2026-07-29T14:37:24.692Z",
    "isFixedExpiry": true,
    "cig": "text",
    "batchCode": "text"
  },
  "economics": {
    "garantedAmount": 1,
    "contractAmount": 1,
    "isAutomaticRenewal": true
  },
  "note": {
    "shared": ""
  },
  "sign": {
    "emissionAt": "2026-07-29T14:37:24.692Z"
  },
  "txHash": "text",
  "notarizationStatus": "PENDING",
  "docs": [
    {
      "type": "BAIL_ACT",
      "key": "text",
      "checksum": "text"
    }
  ],
  "createdAt": "now",
  "id": "text",
  "orgId": "text"
}

curl -L \
  --request POST \
  --url '/api/v1/guarantees' \
  --header 'Content-Type: application/json' \
  --data '{
    "details": {
      "policyNumber": "text",
      "actType": "BAIL_ACT",
      "checkCode": "text",
      "emittedAt": "2026-07-29T14:37:24.692Z",
      "effectiveAt": "2026-07-29T14:37:24.692Z",
      "expiresAt": "2026-07-29T14:37:24.692Z",
      "isFixedExpiry": true,
      "cig": "text",
      "batchCode": "text"
    },
    "economics": {
      "garantedAmount": 1,
      "contractAmount": 1,
      "isAutomaticRenewal": true
    },
    "note": {
      "shared": ""
    },
    "sign": {
      "emissionAt": "2026-07-29T14:37:24.692Z"
    },
    "txHash": "text",
    "notarizationStatus": "PENDING",
    "docs": [
      {
        "type": "BAIL_ACT",
        "key": "text",
        "checksum": "text"
      }
    ],
    "createdAt": "now",
    "id": "text",
    "orgId": "text"
  }'

const response = await fetch('/api/v1/guarantees', {
  method: 'POST',
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "details": {
      "policyNumber": "text",
      "actType": "BAIL_ACT",
      "checkCode": "text",
      "emittedAt": "2026-07-29T14:37:24.692Z",
      "effectiveAt": "2026-07-29T14:37:24.692Z",
      "expiresAt": "2026-07-29T14:37:24.692Z",
      "isFixedExpiry": true,
      "cig": "text",
      "batchCode": "text"
    },
    "economics": {
      "garantedAmount": 1,
      "contractAmount": 1,
      "isAutomaticRenewal": true
    },
    "note": {
      "shared": ""
    },
    "sign": {
      "emissionAt": "2026-07-29T14:37:24.692Z"
    },
    "txHash": "text",
    "notarizationStatus": "PENDING",
    "docs": [
      {
        "type": "BAIL_ACT",
        "key": "text",
        "checksum": "text"
      }
    ],
    "createdAt": "now",
    "id": "text",
    "orgId": "text"
  })
});

const data = await response.json();

import json
import requests

response = requests.post(
    "/api/v1/guarantees",
    headers={"Content-Type":"application/json"},
    data=json.dumps({
      "details": {
        "policyNumber": "text",
        "actType": "BAIL_ACT",
        "checkCode": "text",
        "emittedAt": "2026-07-29T14:37:24.692Z",
        "effectiveAt": "2026-07-29T14:37:24.692Z",
        "expiresAt": "2026-07-29T14:37:24.692Z",
        "isFixedExpiry": True,
        "cig": "text",
        "batchCode": "text"
      },
      "economics": {
        "garantedAmount": 1,
        "contractAmount": 1,
        "isAutomaticRenewal": True
      },
      "note": {
        "shared": ""
      },
      "sign": {
        "emissionAt": "2026-07-29T14:37:24.692Z"
      },
      "txHash": "text",
      "notarizationStatus": "PENDING",
      "docs": [
        {
          "type": "BAIL_ACT",
          "key": "text",
          "checksum": "text"
        }
      ],
      "createdAt": "now",
      "id": "text",
      "orgId": "text"
    })
)

data = response.json()

{
  "details": {
    "policyNumber": "text",
    "actType": "BAIL_ACT",
    "checkCode": "text",
    "emittedAt": "2026-07-29T14:37:24.692Z",
    "effectiveAt": "2026-07-29T14:37:24.692Z",
    "expiresAt": "2026-07-29T14:37:24.692Z",
    "isFixedExpiry": true,
    "cig": "text",
    "batchCode": "text"
  },
  "economics": {
    "garantedAmount": 1,
    "contractAmount": 1,
    "isAutomaticRenewal": true
  },
  "note": {
    "shared": ""
  },
  "sign": {
    "emissionAt": "2026-07-29T14:37:24.692Z"
  },
  "txHash": "text",
  "notarizationStatus": "PENDING",
  "docs": [
    {
      "type": "BAIL_ACT",
      "key": "text",
      "checksum": "text"
    }
  ],
  "createdAt": "now",
  "id": "text",
  "orgId": "text"
}

No content

No content

No content

Path parameters

ID string · required

The unique identifier of the guarantee to retrieve

Responses

200 Success

application/json

details object · GuaranteeDetails · optional

policyNumber string · optional

actType string · enum · nullable · optional

Possible values: BAIL_ACT, POST_SALE, OTHER

checkCode string · nullable · optional

emittedAt string · date-time · nullable · optional

effectiveAt string · date-time · nullable · optional

expiresAt string · date-time · nullable · optional

isFixedExpiry boolean · nullable · optional

cig string · nullable · optional

batchCode string · nullable · optional

economics object · EconomicData · optional

garantedAmount number · nullable · optional

contractAmount number · nullable · optional

isAutomaticRenewal boolean · nullable · optional

note object · Note · optional

shared string · optional

Default: “”

sign object · Sign · optional

emissionAt string · date-time · nullable · optional

txHash string · nullable · optional

notarizationStatus string · enum · nullable · optional

Possible values: PENDING, COMPLETE

docs object · Doc[] · optional

type string · enum · optional

Possible values: BAIL_ACT, POST_SALE, OTHER

key string · optional

checksum string · nullable · optional

createdAt string · date-time · optional

Default: now

id string · optional

orgId string · optional

404 Not found

No content

GET /api/v1/guarantees/{ID}

GET /api/v1/guarantees/{ID} HTTP/1.1
Accept: */*

curl -L \
  --url '/api/v1/guarantees/{ID}' \
  --header 'Accept: */*'

const response = await fetch('/api/v1/guarantees/{ID}', {
  method: 'GET',
  headers: {
    "Accept": "*/*"
  },
});

const data = await response.json();

import requests

response = requests.get(
    "/api/v1/guarantees/{ID}",
    headers={"Accept":"*/*"},
)

data = response.json()

{
  "details": {
    "policyNumber": "text",
    "actType": "BAIL_ACT",
    "checkCode": "text",
    "emittedAt": "2026-07-30T08:27:29.273Z",
    "effectiveAt": "2026-07-30T08:27:29.273Z",
    "expiresAt": "2026-07-30T08:27:29.273Z",
    "isFixedExpiry": true,
    "cig": "text",
    "batchCode": "text"
  },
  "economics": {
    "garantedAmount": 1,
    "contractAmount": 1,
    "isAutomaticRenewal": true
  },
  "note": {
    "shared": ""
  },
  "sign": {
    "emissionAt": "2026-07-30T08:27:29.273Z"
  },
  "txHash": "text",
  "notarizationStatus": "PENDING",
  "docs": [
    {
      "type": "BAIL_ACT",
      "key": "text",
      "checksum": "text"
    }
  ],
  "createdAt": "now",
  "id": "text",
  "orgId": "text"
}

No content

GET /api/v1/guarantees

Create a new guarantee

Get a specific guarantee by ID