API reference · Identity & onboarding
Consents
POST Record a consent for an account holder
POST /accountholder/{type}/{value}/consent
Headers
| Name | Notes |
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Content-Type | application/json |
Path parameters
Example
Request body: ConsentRequest · Response: ConsentResponse
curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/consent" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '{
"purpose": "Ada Obi",
"granted": true,
"grantDateTime": "2027-03-14T14:30:01",
"legalBasis": "Ada Obi"
}'
{
"purpose": "Ada Obi",
"granted": true,
"grantDateTime": "2027-03-14T14:30:01",
"legalBasis": "Ada Obi"
}
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"purpose": "Ada Obi",
"granted": true,
"grantDateTime": "2027-03-14T14:30:01",
"legalBasis": "Ada Obi"
},
"description": "Record a consent for an account holder"
}
Responses
| Status | When |
200 | Consent created successfully |
GET List consents for an account holder
GET /accountholder/{type}/{value}/consents
Headers
| Name | Notes |
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: List<ConsentResponse>
curl -X GET "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/consents" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"
{
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"purpose": "Ada Obi",
"granted": true,
"grantDateTime": "2027-03-14T14:30:01",
"legalBasis": "Ada Obi"
}
],
"description": "List consents for an account holder"
}
Responses
| Status | When |
200 | Consents fetched successfully |
GET Fetch a consent by reference
GET /consent/{id}
Headers
| Name | Notes |
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: ConsentResponse
curl -X GET "https://api.bridgemoni.com/consent/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",
"purpose": "Ada Obi",
"granted": true,
"grantDateTime": "2027-03-14T14:30:01",
"legalBasis": "Ada Obi"
},
"description": "Fetch a consent by reference"
}
Responses
| Status | When |
200 | Consent fetched successfully |
404 | No consent exists for the given reference |
PUT Update a consent
PUT /consent/{id}
Partially updates a consent. 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: UpdateConsentRequest · Response: ConsentResponse
curl -X PUT "https://api.bridgemoni.com/consent/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 '{
"purpose": "Ada Obi",
"granted": true,
"grantDateTime": "2027-03-14T14:30:01",
"legalBasis": "Ada Obi"
}'
{
"purpose": "Ada Obi",
"granted": true,
"grantDateTime": "2027-03-14T14:30:01",
"legalBasis": "Ada Obi"
}
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"purpose": "Ada Obi",
"granted": true,
"grantDateTime": "2027-03-14T14:30:01",
"legalBasis": "Ada Obi"
},
"description": "Update a consent"
}
Responses
| Status | When |
200 | Consent updated successfully |
404 | No consent exists for the given reference |
GET List the resources a consent covers
GET /consent/{id}/resources
Consent names a resource this API exposes - PERSON, EMPLOYMENT, HEALTH - never a field name supplied as data.
Headers
| Name | Notes |
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: GenericResponseListConsentResourceResponse
curl -X GET "https://api.bridgemoni.com/consent/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/resources" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"
{
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"consentedResource": "EMPLOYMENT",
"granted": "true",
"derivedAnswersOnly": "true",
"purpose": {
"name": "string"
}
}
],
"description": "Consent resources fetched successfully"
}
Responses
| Status | When |
200 | Consent resources fetched successfully |
POST Grant or amend the resources a consent covers
POST /consent/{id}/resources
Headers
| Name | Notes |
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Content-Type | application/json |
Path parameters
Example
Request body: List<ConsentResourceRequest> · Response: GenericResponseListConsentResourceResponse
curl -X POST "https://api.bridgemoni.com/consent/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/resources" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '[
{
"consentedResource": "EMPLOYMENT",
"granted": "true",
"derivedAnswersOnly": "true",
"purpose": {
"name": "string"
}
}
]'
[
{
"consentedResource": "EMPLOYMENT",
"granted": "true",
"derivedAnswersOnly": "true",
"purpose": {
"name": "string"
}
}
]
{
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"consentedResource": "EMPLOYMENT",
"granted": "true",
"derivedAnswersOnly": "true",
"purpose": {
"name": "string"
}
}
],
"description": "Consent resources saved successfully"
}
Responses
| Status | When |
200 | Consent resources saved successfully |