API reference · Identity & onboarding

Guardianships

GET/accountholder/{type}/{value}/guardiansList the guardians of an account holder
GET/accountholder/{type}/{value}/guardianshipsList the guardianships an account holder holds over others
GET/guardianship/{reference}Fetch a guardianship

GET List the guardians of an account holder

GET /accountholder/{type}/{value}/guardians

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListGuardianshipResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/guardians" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "guardianUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "wardUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "wardBirthDate": "2026-09-25",
      "wardCountryCode": "string",
      "basis": "PARENTAL",
      "scope": "FULL",
      "instrumentDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "issuingAuthority": {
        "name": "string"
      },
      "grantedDateTime": "2026-09-25T10:00:00Z",
      "expiresDateTime": "2026-09-25T10:00:00Z",
      "revokedDateTime": "2026-09-25T10:00:00Z",
      "live": "true",
      "assuranceGrade": "SELF",
      "verificationStatus": "PENDING",
      "verificationMethod": "string",
      "verifierName": {
        "name": "string"
      },
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Guardians fetched successfully"
}

Responses

Status	When
`200`	Guardians fetched successfully

GET List the guardianships an account holder holds over others

GET /accountholder/{type}/{value}/guardianships

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListGuardianshipResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/guardianships" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "guardianUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "wardUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "wardBirthDate": "2026-09-25",
      "wardCountryCode": "string",
      "basis": "PARENTAL",
      "scope": "FULL",
      "instrumentDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "issuingAuthority": {
        "name": "string"
      },
      "grantedDateTime": "2026-09-25T10:00:00Z",
      "expiresDateTime": "2026-09-25T10:00:00Z",
      "revokedDateTime": "2026-09-25T10:00:00Z",
      "live": "true",
      "assuranceGrade": "SELF",
      "verificationStatus": "PENDING",
      "verificationMethod": "string",
      "verifierName": {
        "name": "string"
      },
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Guardianships fetched successfully"
}

Responses

Status	When
`200`	Guardianships fetched successfully

GET Fetch a guardianship

GET /guardianship/{reference}

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseGuardianshipResponse

curl -X GET "https://api.bridgemoni.com/guardianship/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",
    "guardianUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "wardUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "wardBirthDate": "2026-09-25",
    "wardCountryCode": "string",
    "basis": "PARENTAL",
    "scope": "FULL",
    "instrumentDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "issuingAuthority": {
      "name": "string"
    },
    "grantedDateTime": "2026-09-25T10:00:00Z",
    "expiresDateTime": "2026-09-25T10:00:00Z",
    "revokedDateTime": "2026-09-25T10:00:00Z",
    "live": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Guardianship fetched successfully"
}

Responses

Status	When
`200`	Guardianship fetched successfully
`404`	No guardianship with that reference

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