API reference · Identity & onboarding

Employment

POST/accountholder/{type}/{value}/employmentAdd employment details to an account holder
GET/accountholder/{type}/{value}/employmentsList employment records for an account holder
GET/employment/{id}Fetch employment details by reference
PUT/employment/{id}Update employment details

POST Add employment details to an account holder

POST /accountholder/{type}/{value}/employment

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: EmploymentRequest · Response: EmploymentResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/employment" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "occupation": "Ada Obi",
    "employmentStatus": "EMPLOYED",
    "occupationCode": "category code",
    "employerName": "Ada Obi"
  }'

{
  "occupation": "Ada Obi",
  "employmentStatus": "EMPLOYED",
  "occupationCode": "category code",
  "employerName": "Ada Obi"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "occupation": "Ada Obi",
    "employmentStatus": "EMPLOYED",
    "occupationCode": "category code",
    "employerName": "Ada Obi"
  },
  "description": "Add employment details to an account holder"
}

Responses

Status	When
`200`	Employment created successfully

GET List employment records for an account holder

GET /accountholder/{type}/{value}/employments

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: List<EmploymentResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "occupation": "Ada Obi",
      "employmentStatus": "EMPLOYED",
      "occupationCode": "category code",
      "employerName": "Ada Obi"
    }
  ],
  "description": "List employment records for an account holder"
}

Responses

Status	When
`200`	Employment records fetched successfully

GET Fetch employment details by reference

GET /employment/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: EmploymentResponse

curl -X GET "https://api.bridgemoni.com/employment/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",
    "occupation": "Ada Obi",
    "employmentStatus": "EMPLOYED",
    "occupationCode": "category code",
    "employerName": "Ada Obi"
  },
  "description": "Fetch employment details by reference"
}

Responses

Status	When
`200`	Employment fetched successfully
`404`	No employment record exists for the given reference

PUT Update employment details

PUT /employment/{id}

Partially updates employment details. 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
`id`

Example

Request body: UpdateEmploymentRequest · Response: EmploymentResponse

curl -X PUT "https://api.bridgemoni.com/employment/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 '{
    "occupation": "Ada Obi",
    "employmentStatus": "EMPLOYED",
    "occupationCode": "category code",
    "employerName": "Ada Obi"
  }'

{
  "occupation": "Ada Obi",
  "employmentStatus": "EMPLOYED",
  "occupationCode": "category code",
  "employerName": "Ada Obi"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "occupation": "Ada Obi",
    "employmentStatus": "EMPLOYED",
    "occupationCode": "category code",
    "employerName": "Ada Obi"
  },
  "description": "Update employment details"
}

Responses

Status	When
`200`	Employment updated successfully
`404`	No employment record exists for the given reference

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