API reference · Identity & onboarding

Contacts

POST/accountholder/{type}/{value}/contactAdd a contact to an account holder
GET/accountholder/{type}/{value}/contactsList contacts for an account holder
GET/contact/{id}Fetch a contact by reference
PUT/contact/{id}Update a contact

POST Add a contact to an account holder

POST /accountholder/{type}/{value}/contact

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: ContactRequest · Response: ContactResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/contact" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "emailAddress": "ada@example.com",
    "msisdn": "+2348012345678",
    "preferredChannel": "SMS",
    "preferredLanguageCode": "language code"
  }'

{
  "emailAddress": "ada@example.com",
  "msisdn": "+2348012345678",
  "preferredChannel": "SMS",
  "preferredLanguageCode": "language code"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "emailAddress": "ada@example.com",
    "msisdn": "+2348012345678",
    "preferredChannel": "SMS",
    "preferredLanguageCode": "language code"
  },
  "description": "Add a contact to an account holder"
}

Responses

Status	When
`200`	Contact created successfully

GET List contacts for an account holder

GET /accountholder/{type}/{value}/contacts

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: List<ContactResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "emailAddress": "ada@example.com",
      "msisdn": "+2348012345678",
      "preferredChannel": "SMS",
      "preferredLanguageCode": "language code"
    }
  ],
  "description": "List contacts for an account holder"
}

Responses

Status	When
`200`	Contacts fetched successfully

GET Fetch a contact by reference

GET /contact/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: ContactResponse

curl -X GET "https://api.bridgemoni.com/contact/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",
    "emailAddress": "ada@example.com",
    "msisdn": "+2348012345678",
    "preferredChannel": "SMS",
    "preferredLanguageCode": "language code"
  },
  "description": "Fetch a contact by reference"
}

Responses

Status	When
`200`	Contact fetched successfully
`404`	No contact exists for the given reference

PUT Update a contact

PUT /contact/{id}

Partially updates a contact. Only non-null fields in the request body are applied.

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: UpdateContactRequest · Response: ContactResponse

curl -X PUT "https://api.bridgemoni.com/contact/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 '{
    "emailAddress": "ada@example.com",
    "msisdn": "+2348012345678",
    "preferredChannel": "SMS",
    "preferredLanguageCode": "language code"
  }'

{
  "emailAddress": "ada@example.com",
  "msisdn": "+2348012345678",
  "preferredChannel": "SMS",
  "preferredLanguageCode": "language code"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "emailAddress": "ada@example.com",
    "msisdn": "+2348012345678",
    "preferredChannel": "SMS",
    "preferredLanguageCode": "language code"
  },
  "description": "Update a contact"
}

Responses

Status	When
`200`	Contact updated successfully
`404`	No contact exists for the given reference

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