Bridge
Contact us
API reference · Identity & onboarding

Relationships

POST Record a relationship for an account holder

POST /accountholder/{type}/{value}/relationship

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
type
value

Example

Request body: RelationshipRequest · Response: GenericResponseRelationshipResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/relationship" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "relationshipType": "SPOUSE",
  "relatedUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "relatedName": {
    "name": "string"
  },
  "relatedBirthDate": "2026-09-25",
  "relatedGender": "MALE",
  "relatedMsisdn": "string",
  "relatedEmailAddress": "string",
  "relatedRelationshipLabel": "SELF",
  "dependant": "true",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "active": "true"
}'

Responses

StatusWhen
200Relationships created successfully

GET List an account holder's a relationship

GET /accountholder/{type}/{value}/relationships

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
type
value

Example

Response: GenericResponseListRelationshipResponse

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

Responses

StatusWhen
200Relationships fetched successfully

GET Fetch one record

GET /relationship/{id}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
id

Example

Response: GenericResponseRelationshipResponse

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

Responses

StatusWhen
200Relationships fetched successfully

PUT Update one record

PUT /relationship/{id}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
id

Example

Request body: UpdateRelationshipRequest · Response: GenericResponseRelationshipResponse

curl -X PUT "https://api.bridgemoni.com/relationship/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 '{
  "relationshipType": "SPOUSE",
  "relatedUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "relatedName": {
    "name": "string"
  },
  "relatedBirthDate": "2026-09-25",
  "relatedGender": "MALE",
  "relatedMsisdn": "string",
  "relatedEmailAddress": "string",
  "relatedRelationshipLabel": "SELF",
  "dependant": "true",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "active": "true"
}'

Responses

StatusWhen
200Relationships updated successfully

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