API reference · Identity & onboarding

Document schemes

GET/document/scheme/{countryCode}/{schemeCode}Fetch one document scheme
GET/document/scheme/{id}/constraintsList the legal constraints on a document scheme
GET/document/schemesList the document schemes this platform knows

GET Fetch one document scheme

GET /document/scheme/{countryCode}/{schemeCode}

Headers

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

Path parameters

Name
`countryCode`
`schemeCode`

Example

Response: GenericResponseDocumentSchemeResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "countryCode": "NG",
    "schemeCode": "nin",
    "documentClass": "NATIONAL_ID",
    "issuingAuthority": {
      "name": "string"
    },
    "authorityCountryCode": "NG",
    "formatRule": "^[0-9]{11}$",
    "checksumRule": "VERHOEFF",
    "verifiabilityTier": "V3",
    "blindIndexed": "true",
    "uniquenessAnchor": "true",
    "mrzSupported": "true",
    "chipSupported": "true",
    "walletCredentialAvailable": "true",
    "retentionPolicyDays": "1",
    "storable": "true",
    "active": "true",
    "blocked": "true",
    "constraints": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "constraintCode": "NUMBER_MUST_NOT_BE_STORED",
        "authorityReference": "Aadhaar Act s.29",
        "effectiveFrom": "2026-09-25",
        "effectiveTo": "2026-09-25",
        "blocking": "true"
      }
    ],
    "labels": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "languageCode": "yo",
        "label": "Nomba Idanimo Orile-ede",
        "helpText": "string"
      }
    ],
    "routes": [
      {
        "routeType": "GOVERNMENT_API",
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "routePriority": 1,
        "mediationServiceCode": {
          "name": "string"
        },
        "requiresConsentRecord": "true",
        "active": "true"
      }
    ]
  },
  "description": "Document scheme fetched successfully"
}

Responses

Status	When
`200`	Document scheme fetched successfully
`404`	No scheme is registered for that country and code

GET List the legal constraints on a document scheme

GET /document/scheme/{id}/constraints

The field that actually decides whether a country can ship. A blocking constraint is not a temporary condition.

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseListSchemeConstraintResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "constraintCode": "NUMBER_MUST_NOT_BE_STORED",
      "authorityReference": "Aadhaar Act s.29",
      "effectiveFrom": "2026-09-25",
      "effectiveTo": "2026-09-25",
      "blocking": "true"
    }
  ],
  "description": "Constraints fetched successfully"
}

Responses

Status	When
`200`	Constraints fetched successfully

GET List the document schemes this platform knows

GET /document/schemes

The registry that removes the country list from integrator code. Ask for a document class and the registry resolves which scheme applies in which country.

Headers

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

Query parameters

Name	Default
`country`	Optional

Example

Response: GenericResponseListDocumentSchemeResponse

curl -X GET "https://api.bridgemoni.com/document/schemes" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "countryCode": "NG",
      "schemeCode": "nin",
      "documentClass": "NATIONAL_ID",
      "issuingAuthority": {
        "name": "string"
      },
      "authorityCountryCode": "NG",
      "formatRule": "^[0-9]{11}$",
      "checksumRule": "VERHOEFF",
      "verifiabilityTier": "V3",
      "blindIndexed": "true",
      "uniquenessAnchor": "true",
      "mrzSupported": "true",
      "chipSupported": "true",
      "walletCredentialAvailable": "true",
      "retentionPolicyDays": "1",
      "storable": "true",
      "active": "true",
      "blocked": "true",
      "constraints": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "constraintCode": "NUMBER_MUST_NOT_BE_STORED",
          "authorityReference": "Aadhaar Act s.29",
          "effectiveFrom": "2026-09-25",
          "effectiveTo": "2026-09-25",
          "blocking": "true"
        }
      ],
      "labels": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "languageCode": "yo",
          "label": "Nomba Idanimo Orile-ede",
          "helpText": "string"
        }
      ],
      "routes": [
        {
          "routeType": "GOVERNMENT_API",
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "routePriority": 1,
          "mediationServiceCode": {
            "name": "string"
          },
          "requiresConsentRecord": "true",
          "active": "true"
        }
      ]
    }
  ],
  "description": "Document schemes fetched successfully"
}

Responses

Status	When
`200`	Document schemes fetched successfully

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