API reference · Identity & onboarding

Emergency contacts

POST/accountholder/{type}/{value}/emergency/contactRecord an emergency contact for an account holder
GET/accountholder/{type}/{value}/emergency/contactsList an emergency contact for an account holder
GET/emergency/contact/{id}Fetch one record
PUT/emergency/contact/{id}Update one record

POST Record an emergency contact for an account holder

POST /accountholder/{type}/{value}/emergency/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: EmergencyContactRequest · Response: GenericResponseEmergencyContactResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/emergency/contact" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "contactName": {
    "name": "string"
  },
  "relationship": "SELF",
  "msisdn": "+2348000000000",
  "alternateMsisdn": "string",
  "emailAddress": "ada@example.com",
  "contactPriority": "1",
  "contactUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "releaseInEmergencyCard": "true"
}'

{
  "contactName": {
    "name": "string"
  },
  "relationship": "SELF",
  "msisdn": "+2348000000000",
  "alternateMsisdn": "string",
  "emailAddress": "ada@example.com",
  "contactPriority": "1",
  "contactUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "releaseInEmergencyCard": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "contactName": {
      "name": "string"
    },
    "relationship": "SELF",
    "msisdn": "+2348000000000",
    "alternateMsisdn": "string",
    "emailAddress": "ada@example.com",
    "contactPriority": "1",
    "contactUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "releaseInEmergencyCard": "true",
    "active": "true"
  },
  "description": "An emergency contact recorded successfully"
}

Responses

Status	When
`200`	An emergency contact recorded successfully

GET List an emergency contact for an account holder

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

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListEmergencyContactResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "contactName": {
        "name": "string"
      },
      "relationship": "SELF",
      "msisdn": "+2348000000000",
      "alternateMsisdn": "string",
      "emailAddress": "ada@example.com",
      "contactPriority": "1",
      "contactUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "releaseInEmergencyCard": "true",
      "active": "true"
    }
  ],
  "description": "An emergency contact fetched successfully"
}

Responses

Status	When
`200`	An emergency contact fetched successfully

GET Fetch one record

GET /emergency/contact/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseEmergencyContactResponse

curl -X GET "https://api.bridgemoni.com/emergency/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",
    "contactName": {
      "name": "string"
    },
    "relationship": "SELF",
    "msisdn": "+2348000000000",
    "alternateMsisdn": "string",
    "emailAddress": "ada@example.com",
    "contactPriority": "1",
    "contactUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "releaseInEmergencyCard": "true",
    "active": "true"
  },
  "description": "An emergency contact fetched successfully"
}

Responses

Status	When
`200`	An emergency contact fetched successfully

PUT Update one record

PUT /emergency/contact/{id}

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: UpdateEmergencyContactRequest · Response: GenericResponseEmergencyContactResponse

curl -X PUT "https://api.bridgemoni.com/emergency/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 '{
  "contactName": {
    "name": "string"
  },
  "relationship": "SELF",
  "msisdn": "+2348000000000",
  "alternateMsisdn": "string",
  "emailAddress": "ada@example.com",
  "contactPriority": "1",
  "contactUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "releaseInEmergencyCard": "true",
  "active": "true"
}'

{
  "contactName": {
    "name": "string"
  },
  "relationship": "SELF",
  "msisdn": "+2348000000000",
  "alternateMsisdn": "string",
  "emailAddress": "ada@example.com",
  "contactPriority": "1",
  "contactUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "releaseInEmergencyCard": "true",
  "active": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "contactName": {
      "name": "string"
    },
    "relationship": "SELF",
    "msisdn": "+2348000000000",
    "alternateMsisdn": "string",
    "emailAddress": "ada@example.com",
    "contactPriority": "1",
    "contactUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "releaseInEmergencyCard": "true",
    "active": "true"
  },
  "description": "An emergency contact updated successfully"
}

Responses

Status	When
`200`	An emergency contact updated successfully

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