API reference · Identity & onboarding

Address verification

GET/accountholder/{type}/{value}/address/occupanciesList an account holder's address history
POST/accountholder/{type}/{value}/address/occupancyRecord occupancy of an address
POST/accountholder/{type}/{value}/address/verificationVerify an address
GET/accountholder/{type}/{value}/address/verificationsList an account holder's address verifications
GET/address/verification/{id}Fetch one address verification

GET List an account holder's address history

GET /accountholder/{type}/{value}/address/occupancies

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListAddressOccupancyResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "addressRole": "RESIDENTIAL_CURRENT",
      "occupiedFrom": "2026-09-25",
      "occupiedTo": "2026-09-25",
      "currentAddress": "true",
      "yearsAtAddress": 4
    }
  ],
  "description": "Address history fetched successfully"
}

Responses

Status	When
`200`	Address history fetched successfully

POST Record occupancy of an address

POST /accountholder/{type}/{value}/address/occupancy

Recording a new current address closes the previous one.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`type`
`value`

Example

Request body: AddressOccupancyRequest · Response: GenericResponseAddressOccupancyResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/address/occupancy" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "addressRole": "RESIDENTIAL_CURRENT",
  "occupiedFrom": "2026-09-25",
  "occupiedTo": "2026-09-25",
  "currentAddress": "true"
}'

{
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "addressRole": "RESIDENTIAL_CURRENT",
  "occupiedFrom": "2026-09-25",
  "occupiedTo": "2026-09-25",
  "currentAddress": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressRole": "RESIDENTIAL_CURRENT",
    "occupiedFrom": "2026-09-25",
    "occupiedTo": "2026-09-25",
    "currentAddress": "true",
    "yearsAtAddress": 4
  },
  "description": "Occupancy recorded successfully"
}

Responses

Status	When
`200`	Occupancy recorded successfully

POST Verify an address

POST /accountholder/{type}/{value}/address/verification

The method decides the grade and cannot be overridden - only a registry match reaches REG, and a self-declaration is reported as SELF.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`type`
`value`

Example

Request body: AddressVerificationRequest · Response: GenericResponseAddressVerificationResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/address/verification" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "addressRole": "RESIDENTIAL_CURRENT",
  "verificationMethod": "AGENT_VISIT",
  "verifierName": {
    "name": "string"
  },
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "attestationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "geoLatitude": "6.5244",
  "geoLongitude": "3.3792",
  "geoCapturedDateTime": "2026-09-25T10:00:00Z",
  "plusCode": "string",
  "unstructuredDescription": "Third compound after the blue kiosk, Umuola village road",
  "landmarkDescription": "string",
  "expiryDateTime": "2026-09-25T10:00:00Z"
}'

{
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "addressRole": "RESIDENTIAL_CURRENT",
  "verificationMethod": "AGENT_VISIT",
  "verifierName": {
    "name": "string"
  },
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "attestationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "geoLatitude": "6.5244",
  "geoLongitude": "3.3792",
  "geoCapturedDateTime": "2026-09-25T10:00:00Z",
  "plusCode": "string",
  "unstructuredDescription": "Third compound after the blue kiosk, Umuola village road",
  "landmarkDescription": "string",
  "expiryDateTime": "2026-09-25T10:00:00Z"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressRole": "RESIDENTIAL_CURRENT",
    "verificationMethod": "AGENT_VISIT",
    "verifierName": {
      "name": "string"
    },
    "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "geoLatitude": "6.5244",
    "geoLongitude": "3.3792",
    "geoCapturedDateTime": "2026-09-25T10:00:00Z",
    "plusCode": "string",
    "unstructuredDescription": "Third compound after the blue kiosk, Umuola village road",
    "landmarkDescription": "string",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "suppressed": "true",
    "assuranceGrade": "DOC",
    "verificationStatus": "VERIFIED",
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Address verification recorded successfully"
}

Responses

Status	When
`200`	Address verification recorded successfully

GET List an account holder's address verifications

GET /accountholder/{type}/{value}/address/verifications

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListAddressVerificationResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "addressRole": "RESIDENTIAL_CURRENT",
      "verificationMethod": "AGENT_VISIT",
      "verifierName": {
        "name": "string"
      },
      "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "attestationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "geoLatitude": "6.5244",
      "geoLongitude": "3.3792",
      "geoCapturedDateTime": "2026-09-25T10:00:00Z",
      "plusCode": "string",
      "unstructuredDescription": "Third compound after the blue kiosk, Umuola village road",
      "landmarkDescription": "string",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "suppressed": "true",
      "assuranceGrade": "DOC",
      "verificationStatus": "VERIFIED",
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Address verifications fetched successfully"
}

Responses

Status	When
`200`	Address verifications fetched successfully

GET Fetch one address verification

GET /address/verification/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseAddressVerificationResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressRole": "RESIDENTIAL_CURRENT",
    "verificationMethod": "AGENT_VISIT",
    "verifierName": {
      "name": "string"
    },
    "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "geoLatitude": "6.5244",
    "geoLongitude": "3.3792",
    "geoCapturedDateTime": "2026-09-25T10:00:00Z",
    "plusCode": "string",
    "unstructuredDescription": "Third compound after the blue kiosk, Umuola village road",
    "landmarkDescription": "string",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "suppressed": "true",
    "assuranceGrade": "DOC",
    "verificationStatus": "VERIFIED",
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Address verification fetched successfully"
}

Responses

Status	When
`200`	Address verification fetched successfully

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