API reference · Identity & onboarding
Tax Residences
POST Add a tax residence to an account holder
POST /accountholder/{type}/{value}/tax/residence
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Content-Type | application/json |
Path parameters
Example
Request body: TaxResidenceRequest · Response: TaxResidenceResponse
curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/tax/residence" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '{
"taxIdentificationNumber": "identification number",
"countryCode": "NG",
"taxIdentificationType": "TIN"
}'
{
"taxIdentificationNumber": "identification number",
"countryCode": "NG",
"taxIdentificationType": "TIN"
}
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"taxIdentificationNumber": "identification number",
"countryCode": "NG",
"taxIdentificationType": "TIN"
},
"description": "Add a tax residence to an account holder"
}
Responses
| Status | When |
|---|
200 | Tax residence created successfully |
GET List tax residences for an account holder
GET /accountholder/{type}/{value}/tax/residences
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: List<TaxResidenceResponse>
curl -X GET "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/tax/residences" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"
{
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"taxIdentificationNumber": "identification number",
"countryCode": "NG",
"taxIdentificationType": "TIN"
}
],
"description": "List tax residences for an account holder"
}
Responses
| Status | When |
|---|
200 | Tax residences fetched successfully |
GET Fetch a tax residence by reference
GET /tax/residence/{id}
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: TaxResidenceResponse
curl -X GET "https://api.bridgemoni.com/tax/residence/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",
"taxIdentificationNumber": "identification number",
"countryCode": "NG",
"taxIdentificationType": "TIN"
},
"description": "Fetch a tax residence by reference"
}
Responses
| Status | When |
|---|
200 | Tax residence fetched successfully |
404 | No tax residence exists for the given reference |
PUT Update a tax residence
PUT /tax/residence/{id}
Partially updates a tax residence. 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
Example
Request body: UpdateTaxResidenceRequest · Response: TaxResidenceResponse
curl -X PUT "https://api.bridgemoni.com/tax/residence/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 '{
"taxIdentificationNumber": "identification number",
"countryCode": "NG",
"taxIdentificationType": "TIN"
}'
{
"taxIdentificationNumber": "identification number",
"countryCode": "NG",
"taxIdentificationType": "TIN"
}
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"taxIdentificationNumber": "identification number",
"countryCode": "NG",
"taxIdentificationType": "TIN"
},
"description": "Update a tax residence"
}
Responses
| Status | When |
|---|
200 | Tax residence updated successfully |
404 | No tax residence exists for the given reference |
Bridge