API reference · Identity & onboarding

Tax profile

GET/accountholder/{type}/{value}/tax/profileFetch a tax profile for an account holder
POST/accountholder/{type}/{value}/tax/profileSet a tax profile for an account holder
PUT/accountholder/{type}/{value}/tax/profileUpdate a tax profile for an account holder

GET Fetch a tax profile for an account holder

GET /accountholder/{type}/{value}/tax/profile

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseTaxProfileResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tin": "string",
    "tinAuthority": {
      "name": "string"
    },
    "tinCountryCode": "string",
    "clearanceCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "clearanceIssueDate": "2026-09-25",
    "clearanceExpiryDate": "2026-09-25",
    "filingStatus": "CURRENT",
    "lastFilingPeriod": {
      "name": "string"
    },
    "nextFilingDueDate": "2026-09-25",
    "fatcaStatus": "US_PERSON",
    "crsStatus": "REPORTABLE",
    "selfCertificationDate": "2026-09-25",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "A tax profile fetched successfully"
}

Responses

Status	When
`200`	A tax profile fetched successfully

POST Set a tax profile for an account holder

POST /accountholder/{type}/{value}/tax/profile

The tax identification number is stored and blind-indexed so the same number cannot be claimed twice without the number being searchable in the clear.

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: TaxProfileRequest · Response: GenericResponseTaxProfileResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/tax/profile" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "tin": "string",
  "tinAuthority": {
    "name": "string"
  },
  "tinCountryCode": "string",
  "clearanceCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "clearanceIssueDate": "2026-09-25",
  "clearanceExpiryDate": "2026-09-25",
  "filingStatus": "CURRENT",
  "lastFilingPeriod": {
    "name": "string"
  },
  "nextFilingDueDate": "2026-09-25",
  "fatcaStatus": "US_PERSON",
  "crsStatus": "REPORTABLE",
  "selfCertificationDate": "2026-09-25"
}'

{
  "tin": "string",
  "tinAuthority": {
    "name": "string"
  },
  "tinCountryCode": "string",
  "clearanceCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "clearanceIssueDate": "2026-09-25",
  "clearanceExpiryDate": "2026-09-25",
  "filingStatus": "CURRENT",
  "lastFilingPeriod": {
    "name": "string"
  },
  "nextFilingDueDate": "2026-09-25",
  "fatcaStatus": "US_PERSON",
  "crsStatus": "REPORTABLE",
  "selfCertificationDate": "2026-09-25"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tin": "string",
    "tinAuthority": {
      "name": "string"
    },
    "tinCountryCode": "string",
    "clearanceCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "clearanceIssueDate": "2026-09-25",
    "clearanceExpiryDate": "2026-09-25",
    "filingStatus": "CURRENT",
    "lastFilingPeriod": {
      "name": "string"
    },
    "nextFilingDueDate": "2026-09-25",
    "fatcaStatus": "US_PERSON",
    "crsStatus": "REPORTABLE",
    "selfCertificationDate": "2026-09-25",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "A tax profile saved successfully"
}

Responses

Status	When
`200`	A tax profile saved successfully

PUT Update a tax profile for an account holder

PUT /accountholder/{type}/{value}/tax/profile

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: TaxProfileRequest · Response: GenericResponseTaxProfileResponse

curl -X PUT "https://api.bridgemoni.com/accountholder/value/value/tax/profile" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "tin": "string",
  "tinAuthority": {
    "name": "string"
  },
  "tinCountryCode": "string",
  "clearanceCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "clearanceIssueDate": "2026-09-25",
  "clearanceExpiryDate": "2026-09-25",
  "filingStatus": "CURRENT",
  "lastFilingPeriod": {
    "name": "string"
  },
  "nextFilingDueDate": "2026-09-25",
  "fatcaStatus": "US_PERSON",
  "crsStatus": "REPORTABLE",
  "selfCertificationDate": "2026-09-25"
}'

{
  "tin": "string",
  "tinAuthority": {
    "name": "string"
  },
  "tinCountryCode": "string",
  "clearanceCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "clearanceIssueDate": "2026-09-25",
  "clearanceExpiryDate": "2026-09-25",
  "filingStatus": "CURRENT",
  "lastFilingPeriod": {
    "name": "string"
  },
  "nextFilingDueDate": "2026-09-25",
  "fatcaStatus": "US_PERSON",
  "crsStatus": "REPORTABLE",
  "selfCertificationDate": "2026-09-25"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tin": "string",
    "tinAuthority": {
      "name": "string"
    },
    "tinCountryCode": "string",
    "clearanceCertificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "clearanceIssueDate": "2026-09-25",
    "clearanceExpiryDate": "2026-09-25",
    "filingStatus": "CURRENT",
    "lastFilingPeriod": {
      "name": "string"
    },
    "nextFilingDueDate": "2026-09-25",
    "fatcaStatus": "US_PERSON",
    "crsStatus": "REPORTABLE",
    "selfCertificationDate": "2026-09-25",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "A tax profile updated successfully"
}

Responses

Status	When
`200`	A tax profile updated successfully

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