API reference · Identity & onboarding

Addresses

POST/addressRegister an address
DELETE/address/{id}Delete an address
GET/address/{id}Fetch an address by reference
PUT/address/{id}Update an address
POST/address/{id}/document/{side}Upload a front/back document image for an address
GET/address/{id}/document/{side}/urlFetch a short-lived download URL for an address's front/back document
GET/addressesList addresses belonging to an owner
GET/addresses/by-parentList addresses attached to a geo parent

POST Register an address

POST /address

Attaches to any geo level (country, region, province, district, or city).

Headers

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

Example

Request body: CreateAddressRequest · Response: AddressResponse

curl -X POST "https://api.bridgemoni.com/address" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "addressType": "POSTAL",
    "streetName": "street name",
    "houseNumber": "house number",
    "addressLine2": "address line2",
    "unitNumber": "unit number",
    "postalCode": "101241",
    "plusCode": "plus code",
    "landmark": "landmark",
    "parentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentLevel": "COUNTRY",
    "ownerReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "latitude": 1.0,
    "longitude": 1.0
  }'

{
  "addressType": "POSTAL",
  "streetName": "street name",
  "houseNumber": "house number",
  "addressLine2": "address line2",
  "unitNumber": "unit number",
  "postalCode": "101241",
  "plusCode": "plus code",
  "landmark": "landmark",
  "parentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "parentLevel": "COUNTRY",
  "ownerReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "latitude": 1.0,
  "longitude": 1.0
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressType": "POSTAL",
    "streetName": "street name",
    "buildingNumber": "house number",
    "postCode": "101241",
    "town": "Lagos",
    "district": "district code",
    "province": "province",
    "countryCode": "NG",
    "landmark": "landmark",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier",
    "rejectionReason": "March payroll"
  },
  "description": "Register an address"
}

Responses

Status	When
`200`	Address created successfully

DELETE Delete an address

DELETE /address/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: Void

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

{
  "description": "Delete an address"
}

Responses

Status	When
`200`	Address deleted successfully
`404`	No address exists for the given reference

GET Fetch an address by reference

GET /address/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: AddressResponse

curl -X GET "https://api.bridgemoni.com/address/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",
    "addressType": "POSTAL",
    "streetName": "street name",
    "buildingNumber": "house number",
    "postCode": "101241",
    "town": "Lagos",
    "district": "district code",
    "province": "province",
    "countryCode": "NG",
    "landmark": "landmark",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier",
    "rejectionReason": "March payroll"
  },
  "description": "Fetch an address by reference"
}

Responses

Status	When
`200`	Address fetched successfully
`404`	No address exists for the given reference

PUT Update an address

PUT /address/{id}

Partially updates an address's own scalar fields. The geo parent and owner are immutable after creation.

Headers

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

Path parameters

Name
`id`

Example

Request body: UpdateAddressRequest · Response: AddressResponse

curl -X PUT "https://api.bridgemoni.com/address/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "addressType": "POSTAL",
    "streetName": "street name",
    "buildingNumber": "house number",
    "postCode": "101241",
    "town": "Lagos",
    "district": "district code",
    "province": "province",
    "countryCode": "NG",
    "landmark": "landmark"
  }'

{
  "addressType": "POSTAL",
  "streetName": "street name",
  "buildingNumber": "house number",
  "postCode": "101241",
  "town": "Lagos",
  "district": "district code",
  "province": "province",
  "countryCode": "NG",
  "landmark": "landmark"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressType": "POSTAL",
    "streetName": "street name",
    "buildingNumber": "house number",
    "postCode": "101241",
    "town": "Lagos",
    "district": "district code",
    "province": "province",
    "countryCode": "NG",
    "landmark": "landmark",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier",
    "rejectionReason": "March payroll"
  },
  "description": "Update an address"
}

Responses

Status	When
`200`	Address updated successfully
`404`	No address exists for the given reference

POST Upload a front/back document image for an address

POST /address/{id}/document/{side}

Stores the uploaded file via the document module and attaches its reference to the address's front or back side.

Headers

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

Path parameters

Name
`id`
`side`

Query parameters

Name	Default
`file`	Optional

Example

Response: AddressResponse

curl -X POST "https://api.bridgemoni.com/address/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/document/FRONT?file=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/document.png"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressType": "POSTAL",
    "streetName": "street name",
    "buildingNumber": "house number",
    "postCode": "101241",
    "town": "Lagos",
    "district": "district code",
    "province": "province",
    "countryCode": "NG",
    "landmark": "landmark",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier",
    "rejectionReason": "March payroll"
  },
  "description": "Upload a front/back document image for an address"
}

Responses

Status	When
`200`	Document uploaded successfully
`404`	No address exists for the given reference

GET Fetch a short-lived download URL for an address's front/back document

GET /address/{id}/document/{side}/url

Returns a presigned URL (valid for a limited time) for the requested side.

Headers

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

Path parameters

Name
`id`
`side`

Example

Response: String

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

{
  "data": "text",
  "description": "Fetch a short-lived download URL for an address's front/back document"
}

Responses

Status	When
`200`	Document URL fetched successfully
`404`	No document has been uploaded for this side yet

GET List addresses belonging to an owner

GET /addresses

Headers

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

Query parameters

Name	Default
`ownerReference`	Optional

Example

Response: List<AddressResponse>

curl -X GET "https://api.bridgemoni.com/addresses?ownerReference=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "addressType": "POSTAL",
      "streetName": "street name",
      "buildingNumber": "house number",
      "postCode": "101241",
      "town": "Lagos",
      "district": "district code",
      "province": "province",
      "countryCode": "NG",
      "landmark": "landmark",
      "verificationStatus": "PENDING",
      "verificationMethod": "verification method",
      "frontImageUrl": "unified resource identifier",
      "backImageUrl": "unified resource identifier",
      "rejectionReason": "March payroll"
    }
  ],
  "description": "List addresses belonging to an owner"
}

Responses

Status	When
`200`	Addresses fetched successfully

GET List addresses attached to a geo parent

GET /addresses/by-parent

Headers

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

Query parameters

Name	Default
`parentReference`	Optional

Example

Response: List<AddressResponse>

curl -X GET "https://api.bridgemoni.com/addresses/by-parent?parentReference=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "addressType": "POSTAL",
      "streetName": "street name",
      "buildingNumber": "house number",
      "postCode": "101241",
      "town": "Lagos",
      "district": "district code",
      "province": "province",
      "countryCode": "NG",
      "landmark": "landmark",
      "verificationStatus": "PENDING",
      "verificationMethod": "verification method",
      "frontImageUrl": "unified resource identifier",
      "backImageUrl": "unified resource identifier",
      "rejectionReason": "March payroll"
    }
  ],
  "description": "List addresses attached to a geo parent"
}

Responses

Status	When
`200`	Addresses fetched successfully

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