Bridge
Contact us
API reference · Identity & onboarding

Succession nominations

POST Record a succession nomination for an account holder

POST /accountholder/{type}/{value}/succession/nomination

Headers

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

Path parameters

Name
type
value

Example

Request body: SuccessionNominationRequest · Response: GenericResponseSuccessionNominationResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/succession/nomination" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "nominationType": "EXECUTOR",
  "nomineeName": {
    "name": "string"
  },
  "nomineeUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "nomineeRelationship": "SELF",
  "nomineeContact": "string",
  "sharePercentage": {
    "rate": 0
  },
  "willReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "willCustodian": {
    "name": "string"
  },
  "probateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "digitalLegacyInstruction": "DELETE",
  "notarised": "true",
  "notaryName": {
    "name": "string"
  },
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "nominationDate": "2026-09-25"
}'

Responses

StatusWhen
200A succession nomination recorded successfully

GET List a succession nomination for an account holder

GET /accountholder/{type}/{value}/succession/nominations

Headers

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

Path parameters

Name
type
value

Example

Response: GenericResponseListSuccessionNominationResponse

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

Responses

StatusWhen
200A succession nomination fetched successfully

GET Fetch one record

GET /succession/nomination/{id}

Headers

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

Path parameters

Name
id

Example

Response: GenericResponseSuccessionNominationResponse

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

Responses

StatusWhen
200A succession nomination fetched successfully

PUT Update one record

PUT /succession/nomination/{id}

Headers

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

Path parameters

Name
id

Example

Request body: UpdateSuccessionNominationRequest · Response: GenericResponseSuccessionNominationResponse

curl -X PUT "https://api.bridgemoni.com/succession/nomination/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 '{
  "nominationType": "EXECUTOR",
  "nomineeName": {
    "name": "string"
  },
  "nomineeUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "nomineeRelationship": "SELF",
  "nomineeContact": "string",
  "sharePercentage": {
    "rate": 0
  },
  "willReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "willCustodian": {
    "name": "string"
  },
  "probateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "digitalLegacyInstruction": "DELETE",
  "notarised": "true",
  "notaryName": {
    "name": "string"
  },
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "nominationDate": "2026-09-25",
  "revoked": "true"
}'

Responses

StatusWhen
200A succession nomination updated successfully

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