API reference · Identity & onboarding

Online handles

POST/accountholder/{type}/{value}/online/handleRecord an online handle for an account holder
GET/accountholder/{type}/{value}/online/handlesList an online handle for an account holder
GET/online/handle/{id}Fetch one record
PUT/online/handle/{id}Update one record
PUT/online/handle/{id}/controlProve control of an online handle

POST Record an online handle for an account holder

POST /accountholder/{type}/{value}/online/handle

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: OnlineHandleRequest · Response: GenericResponseOnlineHandleResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/online/handle" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "platformCode": "string",
  "handle": "string",
  "profileUrl": "string",
  "handleType": "SOCIAL",
  "accountCreatedDate": "2026-09-25",
  "accountAgeBand": "string",
  "standing": "GOOD",
  "followerCountBand": "string"
}'

{
  "platformCode": "string",
  "handle": "string",
  "profileUrl": "string",
  "handleType": "SOCIAL",
  "accountCreatedDate": "2026-09-25",
  "accountAgeBand": "string",
  "standing": "GOOD",
  "followerCountBand": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "platformCode": "string",
    "handle": "string",
    "profileUrl": "string",
    "handleType": "SOCIAL",
    "accountCreatedDate": "2026-09-25",
    "accountAgeBand": "string",
    "standing": "GOOD",
    "followerCountBand": "string",
    "controlProofMethod": "OAUTH",
    "controlProvedDateTime": "2026-09-25T10:00:00Z",
    "controlsHandle": "true",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "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": "An online handle recorded successfully"
}

Responses

Status	When
`200`	An online handle recorded successfully

GET List an online handle for an account holder

GET /accountholder/{type}/{value}/online/handles

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListOnlineHandleResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "platformCode": "string",
      "handle": "string",
      "profileUrl": "string",
      "handleType": "SOCIAL",
      "accountCreatedDate": "2026-09-25",
      "accountAgeBand": "string",
      "standing": "GOOD",
      "followerCountBand": "string",
      "controlProofMethod": "OAUTH",
      "controlProvedDateTime": "2026-09-25T10:00:00Z",
      "controlsHandle": "true",
      "lastCheckedDateTime": "2026-09-25T10:00:00Z",
      "active": "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": "An online handle fetched successfully"
}

Responses

Status	When
`200`	An online handle fetched successfully

GET Fetch one record

GET /online/handle/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseOnlineHandleResponse

curl -X GET "https://api.bridgemoni.com/online/handle/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",
    "platformCode": "string",
    "handle": "string",
    "profileUrl": "string",
    "handleType": "SOCIAL",
    "accountCreatedDate": "2026-09-25",
    "accountAgeBand": "string",
    "standing": "GOOD",
    "followerCountBand": "string",
    "controlProofMethod": "OAUTH",
    "controlProvedDateTime": "2026-09-25T10:00:00Z",
    "controlsHandle": "true",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "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": "An online handle fetched successfully"
}

Responses

Status	When
`200`	An online handle fetched successfully

PUT Update one record

PUT /online/handle/{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: UpdateOnlineHandleRequest · Response: GenericResponseOnlineHandleResponse

curl -X PUT "https://api.bridgemoni.com/online/handle/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 '{
  "platformCode": "string",
  "handle": "string",
  "profileUrl": "string",
  "handleType": "SOCIAL",
  "accountCreatedDate": "2026-09-25",
  "accountAgeBand": "string",
  "standing": "GOOD",
  "followerCountBand": "string",
  "active": "true"
}'

{
  "platformCode": "string",
  "handle": "string",
  "profileUrl": "string",
  "handleType": "SOCIAL",
  "accountCreatedDate": "2026-09-25",
  "accountAgeBand": "string",
  "standing": "GOOD",
  "followerCountBand": "string",
  "active": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "platformCode": "string",
    "handle": "string",
    "profileUrl": "string",
    "handleType": "SOCIAL",
    "accountCreatedDate": "2026-09-25",
    "accountAgeBand": "string",
    "standing": "GOOD",
    "followerCountBand": "string",
    "controlProofMethod": "OAUTH",
    "controlProvedDateTime": "2026-09-25T10:00:00Z",
    "controlsHandle": "true",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "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": "An online handle updated successfully"
}

Responses

Status	When
`200`	An online handle updated successfully

PUT Prove control of an online handle

PUT /online/handle/{id}/control

This module proves control, it does not scrape. OAUTH, SIGNED_POST, DNS_TXT and WELL_KNOWN_FILE are the four methods, and what is stored is the proof, the method and the date - never a feed, a follower list or a graph.

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: HandleControlProofRequest · Response: GenericResponseOnlineHandleResponse

curl -X PUT "https://api.bridgemoni.com/online/handle/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/control" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "controlProofMethod": "OAUTH",
  "controlProofReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "controlProofMethod": "OAUTH",
  "controlProofReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "platformCode": "string",
    "handle": "string",
    "profileUrl": "string",
    "handleType": "SOCIAL",
    "accountCreatedDate": "2026-09-25",
    "accountAgeBand": "string",
    "standing": "GOOD",
    "followerCountBand": "string",
    "controlProofMethod": "OAUTH",
    "controlProvedDateTime": "2026-09-25T10:00:00Z",
    "controlsHandle": "true",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "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": "Handle control proved successfully"
}

Responses

Status	When
`200`	Handle control proved successfully

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