API reference · Pricing, reporting & reconciliation

Reconciliation certificates

POST/reconciliation/certificate/{reference}/signSign a certificate
GET/reconciliation/definition/{code}/certificatesList a definition's certificates
GET/reconciliation/run/{reference}/certificateRead the certificate a run produced

POST Sign a certificate

POST /reconciliation/certificate/{reference}/sign

The person who prepared a certificate cannot sign it. That is the whole value of a second name: it belongs to somebody who had to look. The database refuses the alternative as well, so the rule holds for callers that never pass through this endpoint - segregation of duties enforced in a manager alone is true only for as long as every future caller remembers.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseCertificateResponse

curl -X POST "https://api.bridgemoni.com/reconciliation/certificate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/sign" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "runReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "definitionCode": "string",
    "periodStart": "string",
    "periodEnd": "string",
    "preparedBy": "string",
    "preparedAt": "string",
    "signedBy": "string",
    "signedAt": "string",
    "completenessAsserted": true,
    "completenessCaveat": "string",
    "entriesTotal": 0,
    "matchedEntries": 0,
    "matchedValue": "string",
    "openBreakCount": 0,
    "openBreakValue": "string",
    "oldestBreakDays": 0,
    "sideTotals": {},
    "signingKeys": {},
    "contentHash": "string",
    "supersedesCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supersededAt": "string",
    "supersededByCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Certificate signed successfully"
}

Responses

Status	When
`200`	Certificate signed successfully

GET List a definition's certificates

GET /reconciliation/definition/{code}/certificates

Newest first, including superseded ones. A re-run over a period supersedes the earlier certificate and the earlier one is kept: what it asserted was true of the records we held when it was issued, and deleting it would erase the fact that we once said so.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`code`

Example

Response: GenericResponseListCertificateResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/definition/value/certificates" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "runReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "definitionCode": "string",
      "periodStart": "string",
      "periodEnd": "string",
      "preparedBy": "string",
      "preparedAt": "string",
      "signedBy": "string",
      "signedAt": "string",
      "completenessAsserted": true,
      "completenessCaveat": "string",
      "entriesTotal": 0,
      "matchedEntries": 0,
      "matchedValue": "string",
      "openBreakCount": 0,
      "openBreakValue": "string",
      "oldestBreakDays": 0,
      "sideTotals": {},
      "signingKeys": {},
      "contentHash": "string",
      "supersedesCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "supersededAt": "string",
      "supersededByCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ],
  "description": "Certificates retrieved successfully"
}

Responses

Status	When
`200`	Certificates retrieved successfully

GET Read the certificate a run produced

GET /reconciliation/run/{reference}/certificate

A certificate states what was compared, what matched, what is still open and how old the oldest difference is. It carries completenessAsserted, which is false wherever a side had no authoritative channel - a stream-only side cannot prove it delivered everything, and a certificate that quietly implied otherwise would be worth less than none. It also names the key that signed each side, so the assertion can be checked rather than believed. A blocked run has no certificate at all.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseCertificateResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/run/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/certificate" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "runReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "definitionCode": "string",
    "periodStart": "string",
    "periodEnd": "string",
    "preparedBy": "string",
    "preparedAt": "string",
    "signedBy": "string",
    "signedAt": "string",
    "completenessAsserted": true,
    "completenessCaveat": "string",
    "entriesTotal": 0,
    "matchedEntries": 0,
    "matchedValue": "string",
    "openBreakCount": 0,
    "openBreakValue": "string",
    "oldestBreakDays": 0,
    "sideTotals": {},
    "signingKeys": {},
    "contentHash": "string",
    "supersedesCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supersededAt": "string",
    "supersededByCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Certificate retrieved successfully"
}

Responses

Status	When
`200`	Certificate retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors