API reference · Identity & onboarding

Former names

POST/accountholder/{type}/{value}/former/nameRecord a former name for an account holder
GET/accountholder/{type}/{value}/former/namesList an account holder's former names
GET/former/name/{id}Fetch one former name
PUT/former/name/{id}Update one former name

POST Record a former name for an account holder

POST /accountholder/{type}/{value}/former/name

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: FormerNameRequest · Response: GenericResponseFormerNameResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/former/name" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "fullName": "Ada Okafor",
  "givenName": "string",
  "middleName": "Chioma",
  "familyName": "string",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "changeReason": "MARRIAGE",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "fullName": "Ada Okafor",
  "givenName": "string",
  "middleName": "Chioma",
  "familyName": "string",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "changeReason": "MARRIAGE",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "fullName": "Ada Okafor",
    "givenName": "string",
    "middleName": "Chioma",
    "familyName": "string",
    "validFrom": "2026-09-25",
    "validTo": "2026-09-25",
    "changeReason": "MARRIAGE",
    "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "assuranceGrade": "DOC",
    "verificationStatus": "VERIFIED",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Former names created successfully"
}

Responses

Status	When
`200`	Former names created successfully

GET List an account holder's former names

GET /accountholder/{type}/{value}/former/names

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListFormerNameResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "fullName": "Ada Okafor",
      "givenName": "string",
      "middleName": "Chioma",
      "familyName": "string",
      "validFrom": "2026-09-25",
      "validTo": "2026-09-25",
      "changeReason": "MARRIAGE",
      "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "assuranceGrade": "DOC",
      "verificationStatus": "VERIFIED",
      "verificationMethod": "string",
      "verifierName": {
        "name": "string"
      },
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Former names fetched successfully"
}

Responses

Status	When
`200`	Former names fetched successfully

GET Fetch one former name

GET /former/name/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseFormerNameResponse

curl -X GET "https://api.bridgemoni.com/former/name/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",
    "fullName": "Ada Okafor",
    "givenName": "string",
    "middleName": "Chioma",
    "familyName": "string",
    "validFrom": "2026-09-25",
    "validTo": "2026-09-25",
    "changeReason": "MARRIAGE",
    "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "assuranceGrade": "DOC",
    "verificationStatus": "VERIFIED",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Former names fetched successfully"
}

Responses

Status	When
`200`	Former names fetched successfully

PUT Update one former name

PUT /former/name/{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: UpdateFormerNameRequest · Response: GenericResponseFormerNameResponse

curl -X PUT "https://api.bridgemoni.com/former/name/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 '{
  "fullName": "Ada Okafor",
  "givenName": "string",
  "middleName": "Chioma",
  "familyName": "string",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "changeReason": "MARRIAGE",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "fullName": "Ada Okafor",
  "givenName": "string",
  "middleName": "Chioma",
  "familyName": "string",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "changeReason": "MARRIAGE",
  "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "fullName": "Ada Okafor",
    "givenName": "string",
    "middleName": "Chioma",
    "familyName": "string",
    "validFrom": "2026-09-25",
    "validTo": "2026-09-25",
    "changeReason": "MARRIAGE",
    "evidenceDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "assuranceGrade": "DOC",
    "verificationStatus": "VERIFIED",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Former names updated successfully"
}

Responses

Status	When
`200`	Former names updated successfully

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