HelpMyAgent Compliance API

Compliance

GitHub OpenAPI

Operations 1

POST /v1/compliance/name-screen Public Sanctions Name Screen #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/helpmyagent-com:helpmyagent-com-compliance-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

helpmyagent-com-compliance-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: HelpMyAgent Compliance API
  version: v1
  description: Pay-per-call APIs designed to be discovered and consumed by AI agents.
  x-guidance: HelpMyAgent exposes pay-per-call APIs. Choose an operation by its documented purpose, coverage and use_when guidance when available. Use the declared input schema and method. Each paid operation declares its decimal USD price in x-payment-info. An unpaid call returns HTTP 402 with x402 v2 payment requirements; submit a valid payment and retry the same request to receive the business JSON result. Do not use an endpoint outside its declared geographic coverage or documented use case.
  contact:
    url: https://helpmyagent.com
    email: hi@helpmyagent.com
servers:
- url: https://api.helpmyagent.com
  description: HelpMyAgent public API gateway
tags:
- name: Compliance
  description: Compliance
paths:
  /v1/compliance/name-screen:
    post:
      tags:
      - Compliance
      summary: Public Sanctions Name Screen
      description: Screens a name against integrated French, UK and UN public sanctions/freezing lists using explainable fuzzy matching.
      operationId: v1ComplianceNameScreen
      externalDocs:
        description: HelpMyAgent endpoint documentation
        url: https://helpmyagent.com/en/apis/compliance/name-screen
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                    description: Publicly available company, person, buyer or record name for this result.
                  threshold:
                    type: integer
                    description: Structured value returned for “threshold” as defined by this API contract.
                  status:
                    type: string
                    description: Normalized endpoint or source status.
                  match_count:
                    type: integer
                    description: Number of candidate matches returned by the screening operation.
                  matches:
                    type: array
                    items:
                      type: object
                      properties:
                        source:
                          type: string
                          description: Structured value returned for “source” as defined by this API contract.
                        name:
                          type: string
                          description: Publicly available company, person, buyer or record name for this result.
                        score:
                          type: integer
                          description: Normalized score produced by the endpoint; interpretation is defined by the tool description and limitations.
                        reference:
                          type:
                          - string
                          - 'null'
                          description: Structured value returned for “reference” as defined by this API contract.
                        type:
                          type:
                          - string
                          - 'null'
                          description: Structured value returned for “type” as defined by this API contract.
                      additionalProperties: false
                      required:
                      - source
                      - name
                      - score
                      - reference
                      - type
                    description: Candidate public-list or source matches returned by the endpoint.
                  sources:
                    type: array
                    items:
                      type: object
                      properties:
                        source:
                          type: string
                          description: Structured value returned for “source” as defined by this API contract.
                        status:
                          type: string
                          description: Normalized endpoint or source status.
                        records_scanned:
                          type: integer
                          description: Structured value returned for “records scanned” as defined by this API contract.
                        publication_date:
                          type:
                          - string
                          - 'null'
                          description: Structured value returned for “publication date” as defined by this API contract.
                      additionalProperties: false
                      required:
                      - source
                      - status
                      - records_scanned
                      - publication_date
                    description: Public data sources used or checked for this result.
                  checked_at:
                    type: string
                    description: UTC timestamp at which HelpMyAgent performed the check.
                  limitations:
                    type: array
                    items:
                      type: string
                    description: Known interpretation, source-coverage or freshness limitations for this result.
                additionalProperties: false
                required:
                - name
                - threshold
                - status
                - match_count
                - matches
                - sources
                - checked_at
                description: Structured result returned by the compliance/name-screen API.
              example:
                name: LA POSTE
                threshold: 90
                status: PARTIAL_UNAVAILABLE
                match_count: 0
                matches: []
                sources:
                - source: FR_ASSET_FREEZE
                  status: ok
                  records_scanned: 16425
                  publication_date: null
                - source: UK_SANCTIONS
                  status: unavailable
                  records_scanned: 0
                  publication_date: null
                - source: UN_CONSOLIDATED
                  status: unavailable
                  records_scanned: 0
                  publication_date: null
                checked_at: '2026-09-07T16:49:59+02:00'
                limitations:
                - Le rapprochement est textuel et peut produire des faux positifs ou faux négatifs ; un résultat potentiel doit être revu humainement.
                - L’absence de correspondance ne constitue pas une garantie AML/sanctions.
        '402':
          description: Payment required when payment is enabled for the endpoint.
        4XX:
          description: Client request error.
        5XX:
          description: Server or upstream provider error.
      x-helpmyagent-pricing:
        mode: fixed
        price: '0.020'
        currency: USD
        billingPolicy:
          charge_on: valid_result
          no_charge_on_empty_result: true
          no_charge_on_error: true
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '0.020'
        protocols:
        - x402: {}
        accepts:
        - scheme: exact
          network: eip155:8453
          amount: '20000'
          asset: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'
          payTo: '0xEaB9543AcF710a24fe096913A428E7d066c88F59'
          maxTimeoutSeconds: 60
          extra:
            assetTransferMethod: eip3009
            name: USD Coin
            version: '2'
        - scheme: exact
          network: xrpl:0
          amount: '0.02'
          asset: 524C555344000000000000000000000000000000
          payTo: rUXKCZetEbwQc1i5vkJL6SNXYK3hG7Fezy
          maxTimeoutSeconds: 600
          extra:
            sourceTag: 804681468
            issuer: rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De
      x-helpmyagent-coverage:
        countries:
        - FR
        - GB
        - UN
      x-helpmyagent-use-when:
      - Screen a person or organization name against public sanctions lists.
      - You have a person or organization name and need explainable screening against the supported French, UK and UN public sanctions lists.
      - You need candidate matches with fuzzy-match scores before manual review.
      x-helpmyagent-avoid-when:
      - You have a French company identifier and want company-aware public compliance checks; use company/fr/compliance.
      - You need a complete commercial AML/KYC database or a legal guarantee that a subject is unsanctioned.
      x-helpmyagent-limitations:
      - Fuzzy name matching can produce false positives and false negatives, especially for aliases, transliteration and common names.
      - No match means only that no candidate was found in the supported public lists at check time.
      x-helpmyagent-example-queries:
      - Screen a person or organization name against public sanctions lists.
      x-helpmyagent-sources:
      - code: public-sanctions
        name: French, UK and UN public sanctions lists
        url: https://gels-avoirs.dgtresor.gouv.fr
      x-helpmyagent-freshness:
        mode: source_dependent
      x-helpmyagent-mcp-annotations:
        readOnlyHint: false
        destructiveHint: false
        idempotentHint: false
        openWorldHint: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 2
                  maxLength: 200
                  description: Person or organization name to compare with the supported public sanctions and asset-freeze lists. (minimum length 2; maximum length 200).
                threshold:
                  type: integer
                  minimum: 50
                  maximum: 100
                  default: 85
                  description: Minimum fuzzy-match score accepted as a candidate public-list match. (minimum 50; maximum 100; default 85).
              additionalProperties: false
              required:
              - name
              description: Structured input parameters for the compliance/name-screen API.
            example:
              name: LA POSTE
              threshold: 90
      x-helpmyagent-demo:
        url: https://api.helpmyagent.com/demo/compliance/name-screen
        isSnapshot: true
        generatedAt: '2026-09-07T14:49:59+00:00'
        sourceAsOf: null
x-helpmyagent-discovery:
  llms: https://helpmyagent.com/llms.txt
  openapi: https://api.helpmyagent.com/openapi.json
  capabilities: https://helpmyagent.com/capabilities.json
  mcp: https://helpmyagent.com/mcp
  api_catalog: https://helpmyagent.com/.well-known/api-catalog
  pricing: https://helpmyagent.com/pricing.json
  x402: https://helpmyagent.com/.well-known/x402
  x402_service: https://helpmyagent.com/.well-known/x402-service.json
  health: https://helpmyagent.com/health