API reference · Identity & onboarding

Persons

GET/accountholder/{type}/{value}/personFetch an account holder's person profile
POST/accountholder/{type}/{value}/personSet an account holder's person profile
PUT/accountholder/{type}/{value}/personUpdate an account holder's person profile

GET Fetch an account holder's person profile

GET /accountholder/{type}/{value}/person

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: PersonResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "firstName": "first name",
      "lastName": "last name",
      "middleName": "middle name",
      "fullName": "Ada Obi",
      "maidenName": "Ada Obi"
    },
    "birthDate": "2027-03-14",
    "birthCity": "Lagos",
    "birthCountryCode": "NG",
    "genderCode": "MALE",
    "maritalStatus": "SINGLE",
    "nationalityCountryCode": "NG",
    "residentCountryCode": "NG",
    "taxResidences": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "taxIdentificationNumber": "identification number",
        "countryCode": "NG",
        "taxIdentificationType": "TIN"
      }
    ]
  },
  "description": "Fetch an account holder's person profile"
}

Responses

Status	When
`200`	Person fetched successfully
`404`	No person exists for the given user reference

POST Set an account holder's person profile

POST /accountholder/{type}/{value}/person

Creates the person profile for an account holder, cascading creation of the nested name and any supplied tax residences.

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: PersonRequest · Response: PersonResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/person" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "name": {
      "firstName": "first name",
      "lastName": "last name",
      "middleName": "middle name",
      "fullName": "Ada Obi",
      "maidenName": "Ada Obi"
    },
    "birthDate": "2027-03-14",
    "birthCity": "Lagos",
    "birthCountryCode": "NG",
    "genderCode": "MALE",
    "maritalStatus": "SINGLE",
    "nationalityCountryCode": "NG",
    "residentCountryCode": "NG",
    "taxResidences": [
      {
        "taxIdentificationNumber": "identification number",
        "countryCode": "NG",
        "taxIdentificationType": "TIN"
      }
    ]
  }'

{
  "name": {
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "fullName": "Ada Obi",
    "maidenName": "Ada Obi"
  },
  "birthDate": "2027-03-14",
  "birthCity": "Lagos",
  "birthCountryCode": "NG",
  "genderCode": "MALE",
  "maritalStatus": "SINGLE",
  "nationalityCountryCode": "NG",
  "residentCountryCode": "NG",
  "taxResidences": [
    {
      "taxIdentificationNumber": "identification number",
      "countryCode": "NG",
      "taxIdentificationType": "TIN"
    }
  ]
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "firstName": "first name",
      "lastName": "last name",
      "middleName": "middle name",
      "fullName": "Ada Obi",
      "maidenName": "Ada Obi"
    },
    "birthDate": "2027-03-14",
    "birthCity": "Lagos",
    "birthCountryCode": "NG",
    "genderCode": "MALE",
    "maritalStatus": "SINGLE",
    "nationalityCountryCode": "NG",
    "residentCountryCode": "NG",
    "taxResidences": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "taxIdentificationNumber": "identification number",
        "countryCode": "NG",
        "taxIdentificationType": "TIN"
      }
    ]
  },
  "description": "Set an account holder's person profile"
}

Responses

Status	When
`200`	Person created successfully

PUT Update an account holder's person profile

PUT /accountholder/{type}/{value}/person

Partially updates the person's own scalar fields (birth details, gender, marital status, nationality, residency). 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: UpdatePersonRequest · Response: PersonResponse

curl -X PUT "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/person" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "birthDate": "2027-03-14",
    "birthCity": "Lagos",
    "birthCountryCode": "NG",
    "genderCode": "MALE",
    "maritalStatus": "SINGLE",
    "nationalityCountryCode": "NG",
    "residentCountryCode": "NG"
  }'

{
  "birthDate": "2027-03-14",
  "birthCity": "Lagos",
  "birthCountryCode": "NG",
  "genderCode": "MALE",
  "maritalStatus": "SINGLE",
  "nationalityCountryCode": "NG",
  "residentCountryCode": "NG"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "firstName": "first name",
      "lastName": "last name",
      "middleName": "middle name",
      "fullName": "Ada Obi",
      "maidenName": "Ada Obi"
    },
    "birthDate": "2027-03-14",
    "birthCity": "Lagos",
    "birthCountryCode": "NG",
    "genderCode": "MALE",
    "maritalStatus": "SINGLE",
    "nationalityCountryCode": "NG",
    "residentCountryCode": "NG",
    "taxResidences": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "taxIdentificationNumber": "identification number",
        "countryCode": "NG",
        "taxIdentificationType": "TIN"
      }
    ]
  },
  "description": "Update an account holder's person profile"
}

Responses

Status	When
`200`	Person updated successfully
`404`	No person 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