API reference · Identity & onboarding

Consents

POST Record a consent for an account holder

POST /accountholder/{type}/{value}/consent

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
type
value

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"
  }'

Responses

StatusWhen
200Consent created successfully

GET List consents for an account holder

GET /accountholder/{type}/{value}/consents

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
type
value

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"

Responses

StatusWhen
200Consents fetched successfully

POST Grant or amend the resources a consent covers

POST /consent/{id}/resources

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
id

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"
    }
  }
]'

Responses

StatusWhen
200Consent resources saved successfully

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