API reference · Identity & onboarding

Names

GET/accountholder/{type}/{value}/nameFetch an account holder's name
POST/accountholder/{type}/{value}/nameSet an account holder's name
PUT/accountholder/{type}/{value}/nameUpdate an account holder's name

GET Fetch an account holder's name

GET /accountholder/{type}/{value}/name

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: NameResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "fullName": "Ada Obi",
    "maidenName": "Ada Obi"
  },
  "description": "Fetch an account holder's name"
}

Responses

Status	When
`200`	Name fetched successfully
`404`	No name exists for the given user reference

POST Set an account holder's name

POST /accountholder/{type}/{value}/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: NameRequest · Response: NameResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/name" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "fullName": "Ada Obi",
    "maidenName": "Ada Obi"
  }'

{
  "firstName": "first name",
  "lastName": "last name",
  "middleName": "middle name",
  "fullName": "Ada Obi",
  "maidenName": "Ada Obi"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "fullName": "Ada Obi",
    "maidenName": "Ada Obi"
  },
  "description": "Set an account holder's name"
}

Responses

Status	When
`200`	Name created successfully

PUT Update an account holder's name

PUT /accountholder/{type}/{value}/name

Partially updates a name. 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
`type`
`value`

Example

Request body: UpdateNameRequest · Response: NameResponse

curl -X PUT "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/name" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "fullName": "Ada Obi",
    "maidenName": "Ada Obi"
  }'

{
  "firstName": "first name",
  "lastName": "last name",
  "middleName": "middle name",
  "fullName": "Ada Obi",
  "maidenName": "Ada Obi"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "fullName": "Ada Obi",
    "maidenName": "Ada Obi"
  },
  "description": "Update an account holder's name"
}

Responses

Status	When
`200`	Name updated successfully
`404`	No name exists for the given user reference

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