API reference · Identity & onboarding

Social security

POST/accountholder/{type}/{value}/social/security/recordRecord a social security record for an account holder
GET/accountholder/{type}/{value}/social/security/recordsList a social security record for an account holder
GET/social/security/record/{id}Fetch one record
PUT/social/security/record/{id}Update one record

POST Record a social security record for an account holder

POST /accountholder/{type}/{value}/social/security/record

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: SocialSecurityRequest · Response: GenericResponseSocialSecurityResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/social/security/record" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "schemeCode": "string",
  "schemeCountryCode": "string",
  "schemeIdentifier": "string",
  "administratorName": {
    "name": "string"
  },
  "administratorCode": {
    "name": "string"
  },
  "contributionStatus": "CONTRIBUTING",
  "lastContributionDate": "2026-09-25",
  "yearsContributed": "1",
  "enrolledDate": "2026-09-25",
  "balanceBand": "string"
}'

{
  "schemeCode": "string",
  "schemeCountryCode": "string",
  "schemeIdentifier": "string",
  "administratorName": {
    "name": "string"
  },
  "administratorCode": {
    "name": "string"
  },
  "contributionStatus": "CONTRIBUTING",
  "lastContributionDate": "2026-09-25",
  "yearsContributed": "1",
  "enrolledDate": "2026-09-25",
  "balanceBand": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "schemeCode": "string",
    "schemeCountryCode": "string",
    "schemeIdentifier": "string",
    "administratorName": {
      "name": "string"
    },
    "administratorCode": {
      "name": "string"
    },
    "contributionStatus": "CONTRIBUTING",
    "lastContributionDate": "2026-09-25",
    "yearsContributed": "1",
    "enrolledDate": "2026-09-25",
    "balanceBand": "string",
    "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 social security record recorded successfully"
}

Responses

Status	When
`200`	A social security record recorded successfully

GET List a social security record for an account holder

GET /accountholder/{type}/{value}/social/security/records

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListSocialSecurityResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "schemeCode": "string",
      "schemeCountryCode": "string",
      "schemeIdentifier": "string",
      "administratorName": {
        "name": "string"
      },
      "administratorCode": {
        "name": "string"
      },
      "contributionStatus": "CONTRIBUTING",
      "lastContributionDate": "2026-09-25",
      "yearsContributed": "1",
      "enrolledDate": "2026-09-25",
      "balanceBand": "string",
      "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 social security record fetched successfully"
}

Responses

Status	When
`200`	A social security record fetched successfully

GET Fetch one record

GET /social/security/record/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseSocialSecurityResponse

curl -X GET "https://api.bridgemoni.com/social/security/record/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",
    "schemeCode": "string",
    "schemeCountryCode": "string",
    "schemeIdentifier": "string",
    "administratorName": {
      "name": "string"
    },
    "administratorCode": {
      "name": "string"
    },
    "contributionStatus": "CONTRIBUTING",
    "lastContributionDate": "2026-09-25",
    "yearsContributed": "1",
    "enrolledDate": "2026-09-25",
    "balanceBand": "string",
    "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 social security record fetched successfully"
}

Responses

Status	When
`200`	A social security record fetched successfully

PUT Update one record

PUT /social/security/record/{id}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`id`

Example

Request body: UpdateSocialSecurityRequest · Response: GenericResponseSocialSecurityResponse

curl -X PUT "https://api.bridgemoni.com/social/security/record/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 '{
  "schemeCode": "string",
  "schemeCountryCode": "string",
  "schemeIdentifier": "string",
  "administratorName": {
    "name": "string"
  },
  "administratorCode": {
    "name": "string"
  },
  "contributionStatus": "CONTRIBUTING",
  "lastContributionDate": "2026-09-25",
  "yearsContributed": "1",
  "enrolledDate": "2026-09-25",
  "balanceBand": "string"
}'

{
  "schemeCode": "string",
  "schemeCountryCode": "string",
  "schemeIdentifier": "string",
  "administratorName": {
    "name": "string"
  },
  "administratorCode": {
    "name": "string"
  },
  "contributionStatus": "CONTRIBUTING",
  "lastContributionDate": "2026-09-25",
  "yearsContributed": "1",
  "enrolledDate": "2026-09-25",
  "balanceBand": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "schemeCode": "string",
    "schemeCountryCode": "string",
    "schemeIdentifier": "string",
    "administratorName": {
      "name": "string"
    },
    "administratorCode": {
      "name": "string"
    },
    "contributionStatus": "CONTRIBUTING",
    "lastContributionDate": "2026-09-25",
    "yearsContributed": "1",
    "enrolledDate": "2026-09-25",
    "balanceBand": "string",
    "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 social security record updated successfully"
}

Responses

Status	When
`200`	A social security record updated successfully

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