preflight

Free: estimate resolvability, coverage, confidence and price for a CNPJ before paying.

Parameters1

cnpj

string

required

Brazilian CNPJ (14 digits)

Raw schema

{
  "type": "object",
  "properties": {
    "cnpj": {
      "type": "string",
      "description": "Brazilian CNPJ (14 digits)"
    }
  },
  "required": [
    "cnpj"
  ]
}

capabilities

Free: list all capabilities and prices.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {}
}

verify_receipt

Free: verify a signed decision receipt.

Parameters1

receipt

object

required

Raw schema

{
  "type": "object",
  "properties": {
    "receipt": {
      "type": "object"
    }
  },
  "required": [
    "receipt"
  ]
}

verify_passport

Free: verify a signed decision passport.

Parameters1

passport

object

required

Raw schema

{
  "type": "object",
  "properties": {
    "passport": {
      "type": "object"
    }
  },
  "required": [
    "passport"
  ]
}

decide

Paid (x402): objective-based signed decision for a Brazilian company.

Parameters2

subject	object	required
objective	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "subject": {
      "type": "object",
      "properties": {
        "cnpj": {
          "type": "string",
          "description": "Brazilian CNPJ (14 digits)"
        }
      },
      "required": [
        "cnpj"
      ]
    },
    "objective": {
      "type": "string"
    }
  },
  "required": [
    "subject"
  ]
}

counterfactual

Paid (x402): deterministic counterfactual analysis.

Parameters2

subject	object	required
counterfactual	object	optional

Raw schema

{
  "type": "object",
  "properties": {
    "subject": {
      "type": "object",
      "properties": {
        "cnpj": {
          "type": "string",
          "description": "Brazilian CNPJ (14 digits)"
        }
      },
      "required": [
        "cnpj"
      ]
    },
    "counterfactual": {
      "type": "object"
    }
  },
  "required": [
    "subject"
  ]
}

refresh

Paid (x402): incremental refresh of a passport/decision.

Parameters1

passport_id

string

optional

Raw schema

{
  "type": "object",
  "properties": {
    "passport_id": {
      "type": "string"
    }
  }
}

quote

Free: quote for a capability.

Parameters1

capability

string

required

Raw schema

{
  "type": "object",
  "properties": {
    "capability": {
      "type": "string"
    }
  },
  "required": [
    "capability"
  ]
}

resolve_agent_intent

Free: select by canonical intent, brandless problem state or plain-language problem query, including honest negative selection; no source call, charge or settlement.

Parameters3

intent_id	string	optional
problem_state	string	optional
query	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "intent_id": {
      "type": "string"
    },
    "problem_state": {
      "type": "string"
    },
    "query": {
      "type": "string",
      "minLength": 3,
      "maxLength": 500
    }
  },
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "intent_id"
      ]
    },
    {
      "required": [
        "problem_state"
      ]
    },
    {
      "required": [
        "query"
      ]
    }
  ]
}

get_agent_first_portfolio

Free: return Agent ID, five commercial solutions, six exact x402 resources and Passport's non-economic companion role.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

resolve_uk_legal_entity

Paid x402 UK tool for gb.legal_entity.resolve.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters4

company_number	string	optional	Companies House company number, including any two-letter prefix when applicable.
company_name	string	optional
postal_code	string	optional
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "company_name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 300
    },
    "postal_code": {
      "type": "string",
      "maxLength": 20
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "idempotency_key"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "company_number"
      ]
    },
    {
      "required": [
        "company_name"
      ]
    }
  ]
}

verify_uk_company_status

Paid x402 UK tool for gb.company.legal_status.verify.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters2

company_number	string	required	Companies House company number, including any two-letter prefix when applicable.
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "company_number",
    "idempotency_key"
  ],
  "additionalProperties": false
}

match_uk_invoice_to_company

Paid x402 UK tool for gb.invoice.company.match.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters5

company_number	string	required	Companies House company number, including any two-letter prefix when applicable.
invoice_company_name	string	optional	Legal name printed on the invoice.
invoice_address	object	optional
vat_number	string	optional	Optional UK VAT number; this route does not independently verify VAT registration.
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "invoice_company_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 300,
      "description": "Legal name printed on the invoice."
    },
    "invoice_address": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "line_1": {
          "type": "string",
          "maxLength": 300
        },
        "line_2": {
          "type": "string",
          "maxLength": 300
        },
        "locality": {
          "type": "string",
          "maxLength": 200
        },
        "postal_code": {
          "type": "string",
          "maxLength": 20
        },
        "country": {
          "type": "string",
          "maxLength": 80
        }
      }
    },
    "vat_number": {
      "type": "string",
      "maxLength": 20,
      "description": "Optional UK VAT number; this route does not independently verify VAT registration."
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "company_number",
    "idempotency_key"
  ],
  "additionalProperties": false
}

match_uk_business_payee

Paid x402 UK tool for gb.business_payee.match.v1 (LIMITED). Claims are limited to the named official sources.

Parameters4

company_number	string	required	Companies House company number, including any two-letter prefix when applicable.
payee_fingerprint	string	required	Opaque caller-generated fingerprint; never send raw bank-account details.
binding_evidence	object	optional
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "payee_fingerprint": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
    },
    "binding_evidence": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "verified_at",
        "valid_until",
        "reference"
      ],
      "properties": {
        "type": {
          "enum": [
            "PREVIOUSLY_VERIFIED_BINDING",
            "BANK_PROVIDER_CONFIRMATION",
            "CUSTOMER_CONFIRMATION",
            "CHALLENGE"
          ]
        },
        "verified_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the caller or provider verified the binding."
        },
        "valid_until": {
          "type": "string",
          "format": "date-time",
          "description": "Expiry of the caller/provider evidence; must be in the future."
        },
        "reference": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Non-secret reference to the evidence held by the caller."
        }
      }
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "company_number",
    "payee_fingerprint",
    "idempotency_key"
  ],
  "additionalProperties": false
}

approve_uk_supplier

Paid x402 UK tool for gb.supplier.approve.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters7

company_number	string	required	Companies House company number, including any two-letter prefix when applicable.
policy_id	string	required	Declared onboarding policy, normally GB_NEW_SUPPLIER_V1.
sanctions_subject_names	array	optional
vat_number	string	optional
eori_number	string	optional
payee	object	optional
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "policy_id": {
      "type": "string",
      "minLength": 3,
      "maxLength": 120,
      "description": "Declared onboarding policy, normally GB_NEW_SUPPLIER_V1."
    },
    "sanctions_subject_names": {
      "type": "array",
      "maxItems": 25,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "minLength": 3,
        "maxLength": 300
      }
    },
    "vat_number": {
      "type": "string",
      "maxLength": 20
    },
    "eori_number": {
      "type": "string",
      "maxLength": 30
    },
    "payee": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "payee_fingerprint"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "binding_evidence": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "verified_at",
            "valid_until",
            "reference"
          ],
          "properties": {
            "type": {
              "enum": [
                "PREVIOUSLY_VERIFIED_BINDING",
                "BANK_PROVIDER_CONFIRMATION",
                "CUSTOMER_CONFIRMATION",
                "CHALLENGE"
              ]
            },
            "verified_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the caller or provider verified the binding."
            },
            "valid_until": {
              "type": "string",
              "format": "date-time",
              "description": "Expiry of the caller/provider evidence; must be in the future."
            },
            "reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Non-secret reference to the evidence held by the caller."
            }
          }
        }
      }
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "company_number",
    "policy_id",
    "idempotency_key"
  ],
  "additionalProperties": false
}

authorize_uk_vendor_payment_detail_change

Paid x402 UK tool for gb.vendor.payment_detail_change.authorize.v1 (LIMITED). Claims are limited to the named official sources.

Parameters6

company_number	string	required	Companies House company number, including any two-letter prefix when applicable.
current_payee_fingerprint	string	required	Opaque caller-generated fingerprint; never send raw bank-account details.
proposed_payee_fingerprint	string	required	Opaque caller-generated fingerprint; never send raw bank-account details.
prior_authorization_reference	string	required	Reference to the currently approved vendor/payee binding.
challenge	object	required
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "current_payee_fingerprint": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
    },
    "proposed_payee_fingerprint": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
    },
    "prior_authorization_reference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Reference to the currently approved vendor/payee binding."
    },
    "challenge": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "verified_at",
        "valid_until",
        "reference"
      ],
      "properties": {
        "type": {
          "enum": [
            "PREVIOUSLY_VERIFIED_BINDING",
            "BANK_PROVIDER_CONFIRMATION",
            "CUSTOMER_CONFIRMATION",
            "CHALLENGE"
          ]
        },
        "verified_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the caller or provider verified the binding."
        },
        "valid_until": {
          "type": "string",
          "format": "date-time",
          "description": "Expiry of the caller/provider evidence; must be in the future."
        },
        "reference": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Non-secret reference to the evidence held by the caller."
        }
      }
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "company_number",
    "current_payee_fingerprint",
    "proposed_payee_fingerprint",
    "prior_authorization_reference",
    "challenge",
    "idempotency_key"
  ],
  "additionalProperties": false
}

authorize_uk_business_payment

Paid x402 UK tool for gb.business.payment.authorize.v1 (LIMITED). Claims are limited to the named official sources.

Parameters8

company_number	string	required	Companies House company number, including any two-letter prefix when applicable.
supplier	object	required
invoice	object	required
payee	object	required
vendor_change	object	optional
amount	string	required	Positive decimal payment amount in the declared currency; not the x402 fee.
currency	string	required	ISO 4217 currency code for the business payment instruction.
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "supplier": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "policy_id"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "policy_id": {
          "type": "string",
          "minLength": 3,
          "maxLength": 120,
          "description": "Declared onboarding policy, normally GB_NEW_SUPPLIER_V1."
        },
        "sanctions_subject_names": {
          "type": "array",
          "maxItems": 25,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "minLength": 3,
            "maxLength": 300
          }
        },
        "vat_number": {
          "type": "string",
          "maxLength": 20
        },
        "eori_number": {
          "type": "string",
          "maxLength": 30
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number",
            "payee_fingerprint"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "payee_fingerprint": {
              "type": "string",
              "minLength": 8,
              "maxLength": 200,
              "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
            },
            "binding_evidence": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "type",
                "verified_at",
                "valid_until",
                "reference"
              ],
              "properties": {
                "type": {
                  "enum": [
                    "PREVIOUSLY_VERIFIED_BINDING",
                    "BANK_PROVIDER_CONFIRMATION",
                    "CUSTOMER_CONFIRMATION",
                    "CHALLENGE"
                  ]
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When the caller or provider verified the binding."
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Expiry of the caller/provider evidence; must be in the future."
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200,
                  "description": "Non-secret reference to the evidence held by the caller."
                }
              }
            }
          }
        }
      }
    },
    "invoice": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "invoice_company_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 300,
          "description": "Legal name printed on the invoice."
        },
        "invoice_address": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "line_1": {
              "type": "string",
              "maxLength": 300
            },
            "line_2": {
              "type": "string",
              "maxLength": 300
            },
            "locality": {
              "type": "string",
              "maxLength": 200
            },
            "postal_code": {
              "type": "string",
              "maxLength": 20
            },
            "country": {
              "type": "string",
              "maxLength": 80
            }
          }
        },
        "vat_number": {
          "type": "string",
          "maxLength": 20,
          "description": "Optional UK VAT number; this route does not independently verify VAT registration."
        }
      }
    },
    "payee": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "payee_fingerprint"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "binding_evidence": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "verified_at",
            "valid_until",
            "reference"
          ],
          "properties": {
            "type": {
              "enum": [
                "PREVIOUSLY_VERIFIED_BINDING",
                "BANK_PROVIDER_CONFIRMATION",
                "CUSTOMER_CONFIRMATION",
                "CHALLENGE"
              ]
            },
            "verified_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the caller or provider verified the binding."
            },
            "valid_until": {
              "type": "string",
              "format": "date-time",
              "description": "Expiry of the caller/provider evidence; must be in the future."
            },
            "reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Non-secret reference to the evidence held by the caller."
            }
          }
        }
      }
    },
    "vendor_change": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "current_payee_fingerprint",
        "proposed_payee_fingerprint",
        "prior_authorization_reference",
        "challenge",
        "idempotency_key"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "current_payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "proposed_payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "prior_authorization_reference": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Reference to the currently approved vendor/payee binding."
        },
        "challenge": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "verified_at",
            "valid_until",
            "reference"
          ],
          "properties": {
            "type": {
              "enum": [
                "PREVIOUSLY_VERIFIED_BINDING",
                "BANK_PROVIDER_CONFIRMATION",
                "CUSTOMER_CONFIRMATION",
                "CHALLENGE"
              ]
            },
            "verified_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the caller or provider verified the binding."
            },
            "valid_until": {
              "type": "string",
              "format": "date-time",
              "description": "Expiry of the caller/provider evidence; must be in the future."
            },
            "reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Non-secret reference to the evidence held by the caller."
            }
          }
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      }
    },
    "amount": {
      "type": "string",
      "pattern": "^\\d+(?:\\.\\d{1,2})?$",
      "description": "Positive decimal payment amount in the declared currency; not the x402 fee."
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "ISO 4217 currency code for the business payment instruction."
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "company_number",
    "supplier",
    "invoice",
    "payee",
    "amount",
    "currency",
    "idempotency_key"
  ],
  "additionalProperties": false
}

screen_restricted_business_party

Public no-charge UK tool for restricted_business_party.screen.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

continue_vendor_authorization

Public no-charge UK tool for vendor.authorization.continue.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

build_uk_company_capability_passport

Metadata-only; authenticated HTTP operator access required UK tool for company.capability.passport.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

assess_uk_invoice_authenticity_duplication

Public no-charge UK tool for gb.invoice.authenticity_duplication.assess.v1 (LIMITED). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

verify_uk_bank_account_ownership

Public no-charge UK tool for gb.bank_account_ownership.verify.v1 (SOURCE_CONDITIONED). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

detect_uk_company_material_change

Public no-charge UK tool for gb.company.material_change.detect.v1 (LIMITED). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

verify_uk_business_licence

Public no-charge UK tool for gb.business_licence.verify.v1 (SOURCE_CONDITIONED). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

verify_uk_tax_registration

Public no-charge UK tool for gb.tax_registration.verify.v1 (SOURCE_CONDITIONED). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

validate_uk_business_document

Public no-charge UK tool for gb.business_document.validate.v1 (LIMITED). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

verify_uk_beneficial_ownership_control

Public no-charge UK tool for gb.beneficial_ownership_control.verify.v1 (LIMITED). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

assess_uk_source_evidence_freshness

Public no-charge UK tool for gb.source_evidence_freshness.assess.v1 (LIMITED). Claims are limited to the named official sources.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "additionalProperties": true
}

run_uk_company_check

Paid x402 UK tool for gb.solution.company_check.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters4

company_number	string	optional	Companies House company number, including any two-letter prefix when applicable.
company_name	string	optional
postal_code	string	optional
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "company_name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 300
    },
    "postal_code": {
      "type": "string",
      "maxLength": 20
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "idempotency_key"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "company_number"
      ]
    },
    {
      "required": [
        "company_name"
      ]
    }
  ]
}

run_uk_supplier_approval

Paid x402 UK tool for gb.solution.supplier_approval.v1 (AVAILABLE). Claims are limited to the named official sources.

Parameters7

company_number	string	required	Companies House company number, including any two-letter prefix when applicable.
policy_id	string	required	Declared onboarding policy, normally GB_NEW_SUPPLIER_V1.
sanctions_subject_names	array	optional
vat_number	string	optional
eori_number	string	optional
payee	object	optional
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "policy_id": {
      "type": "string",
      "minLength": 3,
      "maxLength": 120,
      "description": "Declared onboarding policy, normally GB_NEW_SUPPLIER_V1."
    },
    "sanctions_subject_names": {
      "type": "array",
      "maxItems": 25,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "minLength": 3,
        "maxLength": 300
      }
    },
    "vat_number": {
      "type": "string",
      "maxLength": 20
    },
    "eori_number": {
      "type": "string",
      "maxLength": 30
    },
    "payee": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "payee_fingerprint"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "binding_evidence": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "verified_at",
            "valid_until",
            "reference"
          ],
          "properties": {
            "type": {
              "enum": [
                "PREVIOUSLY_VERIFIED_BINDING",
                "BANK_PROVIDER_CONFIRMATION",
                "CUSTOMER_CONFIRMATION",
                "CHALLENGE"
              ]
            },
            "verified_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the caller or provider verified the binding."
            },
            "valid_until": {
              "type": "string",
              "format": "date-time",
              "description": "Expiry of the caller/provider evidence; must be in the future."
            },
            "reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Non-secret reference to the evidence held by the caller."
            }
          }
        }
      }
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "company_number",
    "policy_id",
    "idempotency_key"
  ],
  "additionalProperties": false
}

verify_uk_invoice_and_payee

Paid x402 UK tool for gb.solution.invoice_payee_verification.v1 (LIMITED). Claims are limited to the named official sources.

Parameters3

invoice	object	required
payee	object	required
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "invoice": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "invoice_company_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 300,
          "description": "Legal name printed on the invoice."
        },
        "invoice_address": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "line_1": {
              "type": "string",
              "maxLength": 300
            },
            "line_2": {
              "type": "string",
              "maxLength": 300
            },
            "locality": {
              "type": "string",
              "maxLength": 200
            },
            "postal_code": {
              "type": "string",
              "maxLength": 20
            },
            "country": {
              "type": "string",
              "maxLength": 80
            }
          }
        },
        "vat_number": {
          "type": "string",
          "maxLength": 20,
          "description": "Optional UK VAT number; this route does not independently verify VAT registration."
        }
      }
    },
    "payee": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "payee_fingerprint"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "binding_evidence": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "verified_at",
            "valid_until",
            "reference"
          ],
          "properties": {
            "type": {
              "enum": [
                "PREVIOUSLY_VERIFIED_BINDING",
                "BANK_PROVIDER_CONFIRMATION",
                "CUSTOMER_CONFIRMATION",
                "CHALLENGE"
              ]
            },
            "verified_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the caller or provider verified the binding."
            },
            "valid_until": {
              "type": "string",
              "format": "date-time",
              "description": "Expiry of the caller/provider evidence; must be in the future."
            },
            "reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Non-secret reference to the evidence held by the caller."
            }
          }
        }
      }
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "invoice",
    "payee",
    "idempotency_key"
  ],
  "additionalProperties": false
}

run_uk_payment_authorization

Paid x402 UK tool for gb.solution.payment_authorization.v1 (LIMITED). Claims are limited to the named official sources.

Parameters8

company_number	string	required	Companies House company number, including any two-letter prefix when applicable.
supplier	object	required
invoice	object	required
payee	object	required
vendor_change	object	optional
amount	string	required	Positive decimal payment amount in the declared currency; not the x402 fee.
currency	string	required	ISO 4217 currency code for the business payment instruction.
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "company_number": {
      "type": "string",
      "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
      "description": "Companies House company number, including any two-letter prefix when applicable."
    },
    "supplier": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "policy_id"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "policy_id": {
          "type": "string",
          "minLength": 3,
          "maxLength": 120,
          "description": "Declared onboarding policy, normally GB_NEW_SUPPLIER_V1."
        },
        "sanctions_subject_names": {
          "type": "array",
          "maxItems": 25,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "minLength": 3,
            "maxLength": 300
          }
        },
        "vat_number": {
          "type": "string",
          "maxLength": 20
        },
        "eori_number": {
          "type": "string",
          "maxLength": 30
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number",
            "payee_fingerprint"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "payee_fingerprint": {
              "type": "string",
              "minLength": 8,
              "maxLength": 200,
              "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
            },
            "binding_evidence": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "type",
                "verified_at",
                "valid_until",
                "reference"
              ],
              "properties": {
                "type": {
                  "enum": [
                    "PREVIOUSLY_VERIFIED_BINDING",
                    "BANK_PROVIDER_CONFIRMATION",
                    "CUSTOMER_CONFIRMATION",
                    "CHALLENGE"
                  ]
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When the caller or provider verified the binding."
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Expiry of the caller/provider evidence; must be in the future."
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200,
                  "description": "Non-secret reference to the evidence held by the caller."
                }
              }
            }
          }
        }
      }
    },
    "invoice": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "invoice_company_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 300,
          "description": "Legal name printed on the invoice."
        },
        "invoice_address": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "line_1": {
              "type": "string",
              "maxLength": 300
            },
            "line_2": {
              "type": "string",
              "maxLength": 300
            },
            "locality": {
              "type": "string",
              "maxLength": 200
            },
            "postal_code": {
              "type": "string",
              "maxLength": 20
            },
            "country": {
              "type": "string",
              "maxLength": 80
            }
          }
        },
        "vat_number": {
          "type": "string",
          "maxLength": 20,
          "description": "Optional UK VAT number; this route does not independently verify VAT registration."
        }
      }
    },
    "payee": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "payee_fingerprint"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "binding_evidence": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "verified_at",
            "valid_until",
            "reference"
          ],
          "properties": {
            "type": {
              "enum": [
                "PREVIOUSLY_VERIFIED_BINDING",
                "BANK_PROVIDER_CONFIRMATION",
                "CUSTOMER_CONFIRMATION",
                "CHALLENGE"
              ]
            },
            "verified_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the caller or provider verified the binding."
            },
            "valid_until": {
              "type": "string",
              "format": "date-time",
              "description": "Expiry of the caller/provider evidence; must be in the future."
            },
            "reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Non-secret reference to the evidence held by the caller."
            }
          }
        }
      }
    },
    "vendor_change": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "current_payee_fingerprint",
        "proposed_payee_fingerprint",
        "prior_authorization_reference",
        "challenge",
        "idempotency_key"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "current_payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "proposed_payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "prior_authorization_reference": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Reference to the currently approved vendor/payee binding."
        },
        "challenge": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "verified_at",
            "valid_until",
            "reference"
          ],
          "properties": {
            "type": {
              "enum": [
                "PREVIOUSLY_VERIFIED_BINDING",
                "BANK_PROVIDER_CONFIRMATION",
                "CUSTOMER_CONFIRMATION",
                "CHALLENGE"
              ]
            },
            "verified_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the caller or provider verified the binding."
            },
            "valid_until": {
              "type": "string",
              "format": "date-time",
              "description": "Expiry of the caller/provider evidence; must be in the future."
            },
            "reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Non-secret reference to the evidence held by the caller."
            }
          }
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      }
    },
    "amount": {
      "type": "string",
      "pattern": "^\\d+(?:\\.\\d{1,2})?$",
      "description": "Positive decimal payment amount in the declared currency; not the x402 fee."
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "ISO 4217 currency code for the business payment instruction."
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "company_number",
    "supplier",
    "invoice",
    "payee",
    "amount",
    "currency",
    "idempotency_key"
  ],
  "additionalProperties": false
}

run_uk_vendor_change_continuous_authorization

Paid x402 UK tool for gb.solution.vendor_change_continuous_authorization.v1 (LIMITED). Claims are limited to the named official sources.

Parameters2

change	object	required
idempotency_key	string	required	Caller-generated key. Send the identical value in the Idempotency-Key header.

Raw schema

{
  "type": "object",
  "properties": {
    "change": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "company_number",
        "current_payee_fingerprint",
        "proposed_payee_fingerprint",
        "prior_authorization_reference",
        "challenge",
        "idempotency_key"
      ],
      "properties": {
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "current_payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "proposed_payee_fingerprint": {
          "type": "string",
          "minLength": 8,
          "maxLength": 200,
          "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
        },
        "prior_authorization_reference": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Reference to the currently approved vendor/payee binding."
        },
        "challenge": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "verified_at",
            "valid_until",
            "reference"
          ],
          "properties": {
            "type": {
              "enum": [
                "PREVIOUSLY_VERIFIED_BINDING",
                "BANK_PROVIDER_CONFIRMATION",
                "CUSTOMER_CONFIRMATION",
                "CHALLENGE"
              ]
            },
            "verified_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the caller or provider verified the binding."
            },
            "valid_until": {
              "type": "string",
              "format": "date-time",
              "description": "Expiry of the caller/provider evidence; must be in the future."
            },
            "reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Non-secret reference to the evidence held by the caller."
            }
          }
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      }
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{8,120}$",
      "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
    }
  },
  "required": [
    "change",
    "idempotency_key"
  ],
  "additionalProperties": false
}

resolve_legal_entity

Global RunOnProof tool. Choose country from BR, GB; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "legal_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 240
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        },
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "company_name": {
          "type": "string",
          "minLength": 2,
          "maxLength": 300
        },
        "postal_code": {
          "type": "string",
          "maxLength": 20
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      },
      "required": [
        "country",
        "idempotency_key"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB"
  ]
}

verify_company_status

Global RunOnProof tool. Choose country from BR, GB; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        },
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      },
      "required": [
        "country",
        "company_number",
        "idempotency_key"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB"
  ]
}

screen_restricted_party

Global RunOnProof tool. Choose country from BR, GB; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "legal_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 240
        },
        "aliases": {
          "type": "array",
          "maxItems": 20,
          "default": [],
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        }
      },
      "required": [
        "country"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB"
  ]
}

company_check

Global RunOnProof tool. Choose country from BR, GB, US; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB",
        "US"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        },
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "company_name": {
          "type": "string",
          "minLength": 2,
          "maxLength": 300
        },
        "postal_code": {
          "type": "string",
          "maxLength": 20
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      },
      "required": [
        "country",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "US"
        },
        "company": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "identifier",
            "legal_name",
            "jurisdiction"
          ],
          "properties": {
            "identifier": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "scheme",
                "value",
                "evidence_reference"
              ],
              "properties": {
                "scheme": {
                  "type": "string",
                  "enum": [
                    "STATE_ENTITY_NUMBER",
                    "UEI",
                    "CAGE",
                    "NPI",
                    "USDOT",
                    "MC",
                    "CIK",
                    "LEI"
                  ]
                },
                "value": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                },
                "evidence_reference": {
                  "type": "string",
                  "pattern": "^(?:https://[^?\\s#]+|canonical-entity:[A-Za-z0-9_-]+)$"
                }
              }
            },
            "legal_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 500
            },
            "jurisdiction": {
              "type": "string",
              "pattern": "^US(?:-[A-Z]{2})?$"
            },
            "entity_id": {
              "type": "string",
              "pattern": "^ent_[A-Za-z0-9_-]+$"
            }
          }
        },
        "policy_id": {
          "const": "US_COMPANY_CHECK_V1"
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "company",
        "policy_id",
        "idempotency_key"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB",
    "US"
  ]
}

approve_supplier

Global RunOnProof tool. Choose country from BR, GB, US; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB",
        "US"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "policy_id": {
          "const": "BR_SUPPLIER_APPROVAL_V1"
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "cnpj": {
              "type": "string",
              "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
            },
            "payee_fingerprint": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "binding_evidence": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "enum": [
                    "PROVIDER_ATTESTATION",
                    "INDEPENDENT_CONFIRMATION",
                    "SIGNED_CHALLENGE",
                    "PREVIOUSLY_VERIFIED_BINDING"
                  ]
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 240
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time"
                },
                "subject_cnpj": {
                  "type": "string",
                  "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
                },
                "payee_fingerprint": {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                }
              },
              "required": [
                "type",
                "reference",
                "verified_at",
                "valid_until",
                "subject_cnpj",
                "payee_fingerprint"
              ]
            }
          },
          "required": [
            "cnpj",
            "payee_fingerprint"
          ]
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "policy_id",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        },
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "policy_id": {
          "type": "string",
          "minLength": 3,
          "maxLength": 120,
          "description": "Declared onboarding policy, normally GB_NEW_SUPPLIER_V1."
        },
        "sanctions_subject_names": {
          "type": "array",
          "maxItems": 25,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "minLength": 3,
            "maxLength": 300
          }
        },
        "vat_number": {
          "type": "string",
          "maxLength": 20
        },
        "eori_number": {
          "type": "string",
          "maxLength": 30
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number",
            "payee_fingerprint"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "payee_fingerprint": {
              "type": "string",
              "minLength": 8,
              "maxLength": 200,
              "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
            },
            "binding_evidence": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "type",
                "verified_at",
                "valid_until",
                "reference"
              ],
              "properties": {
                "type": {
                  "enum": [
                    "PREVIOUSLY_VERIFIED_BINDING",
                    "BANK_PROVIDER_CONFIRMATION",
                    "CUSTOMER_CONFIRMATION",
                    "CHALLENGE"
                  ]
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When the caller or provider verified the binding."
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Expiry of the caller/provider evidence; must be in the future."
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200,
                  "description": "Non-secret reference to the evidence held by the caller."
                }
              }
            }
          }
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      },
      "required": [
        "country",
        "company_number",
        "policy_id",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "US"
        },
        "supplier": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "caller_supplier_reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "entity_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "identifier": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "STATE_ENTITY_NUMBER",
                    "UEI",
                    "CAGE",
                    "NPI",
                    "USDOT",
                    "MC",
                    "CIK",
                    "LEI",
                    "EIN"
                  ]
                },
                "value": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "fingerprint": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80,
                  "pattern": "^sha256:[a-f0-9]{64}$"
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120
                },
                "jurisdiction": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 5,
                  "pattern": "^US-(A[LKZR]|C[AOT]|D[CE]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOST]|N[CDEHJMVY]|O[HKR]|P[AR]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])$"
                }
              },
              "required": [
                "type"
              ]
            },
            "legal_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "jurisdiction": {
              "type": "string",
              "minLength": 1,
              "maxLength": 5,
              "pattern": "^US-(A[LKZR]|C[AOT]|D[CE]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOST]|N[CDEHJMVY]|O[HKR]|P[AR]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])$"
            },
            "product_or_service": {
              "type": "string",
              "minLength": 1,
              "maxLength": 300
            },
            "sector": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "relationship": {
              "const": "NEW_SUPPLIER"
            },
            "spend_band": {
              "type": "string",
              "enum": [
                "MICRO",
                "LOW",
                "MEDIUM",
                "HIGH",
                "VERY_HIGH"
              ]
            }
          },
          "required": [
            "caller_supplier_reference",
            "legal_name",
            "jurisdiction",
            "relationship",
            "spend_band"
          ]
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "X402_PAYTO",
                "WALLET",
                "MERCHANT_RESOURCE",
                "PAYOUT_DESTINATION_TOKEN",
                "PROVIDER_ACCOUNT_TOKEN"
              ]
            },
            "value": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            },
            "provider": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "merchant_url": {
              "type": "string",
              "minLength": 1,
              "maxLength": 500,
              "format": "uri",
              "pattern": "^https://"
            },
            "fingerprint": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80,
              "pattern": "^sha256:[a-f0-9]{64}$"
            },
            "provider_namespace": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            }
          },
          "required": [
            "type",
            "value"
          ]
        },
        "documents": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "document_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "document_digest": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "pattern": "^sha256:[a-f0-9]{64}$"
              },
              "type": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              }
            },
            "required": [
              "document_id",
              "document_digest",
              "type"
            ]
          },
          "maxItems": 30
        },
        "policy": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "id": {
              "type": "string",
              "enum": [
                "US_LEGAL_EXISTENCE_V1",
                "US_COMPANY_CHECK_V1",
                "US_INVOICE_MATCH_V1",
                "US_PAYEE_BINDING_V1",
                "US_INVOICE_PAYEE_VERIFICATION_V1",
                "US_NEW_SUPPLIER_V1",
                "US_FEDERAL_COUNTERPARTY_V1",
                "US_VENDOR_PAYMENT_DETAIL_CHANGE_V1",
                "US_LOW_VALUE_PAYMENT_V1",
                "US_EXISTING_SUPPLIER_PAYMENT_V1",
                "US_HIGH_VALUE_PAYMENT_V1",
                "US_NEW_SUPPLIER_PAYMENT_V1",
                "US_PAYMENT_AUTHORIZATION_V1"
              ]
            },
            "version": {
              "const": "1.0.0"
            }
          },
          "required": [
            "id",
            "version"
          ]
        }
      },
      "required": [
        "country",
        "supplier"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB",
    "US"
  ]
}

verify_invoice_payee

Global RunOnProof tool. Choose country from BR, GB, US; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB",
        "US"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "invoice": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "invoice_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            },
            "supplier_cnpj": {
              "type": "string",
              "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
            },
            "supplier_legal_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            },
            "supplier_address": {
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            },
            "issue_date": {
              "type": "string",
              "format": "date"
            },
            "amount": {
              "type": "string",
              "pattern": "^\\d{1,18}(?:\\.\\d{1,6})?$"
            },
            "currency": {
              "const": "BRL",
              "default": "BRL"
            }
          },
          "required": [
            "invoice_id",
            "supplier_cnpj",
            "supplier_legal_name"
          ]
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "payee_fingerprint": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "binding_evidence": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "enum": [
                    "PROVIDER_ATTESTATION",
                    "INDEPENDENT_CONFIRMATION",
                    "SIGNED_CHALLENGE",
                    "PREVIOUSLY_VERIFIED_BINDING"
                  ]
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 240
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time"
                },
                "subject_cnpj": {
                  "type": "string",
                  "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
                },
                "payee_fingerprint": {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                }
              },
              "required": [
                "type",
                "reference",
                "verified_at",
                "valid_until",
                "subject_cnpj",
                "payee_fingerprint"
              ]
            }
          },
          "required": [
            "payee_fingerprint"
          ]
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "invoice",
        "payee",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        },
        "invoice": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "invoice_company_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 300,
              "description": "Legal name printed on the invoice."
            },
            "invoice_address": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "line_1": {
                  "type": "string",
                  "maxLength": 300
                },
                "line_2": {
                  "type": "string",
                  "maxLength": 300
                },
                "locality": {
                  "type": "string",
                  "maxLength": 200
                },
                "postal_code": {
                  "type": "string",
                  "maxLength": 20
                },
                "country": {
                  "type": "string",
                  "maxLength": 80
                }
              }
            },
            "vat_number": {
              "type": "string",
              "maxLength": 20,
              "description": "Optional UK VAT number; this route does not independently verify VAT registration."
            }
          }
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number",
            "payee_fingerprint"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "payee_fingerprint": {
              "type": "string",
              "minLength": 8,
              "maxLength": 200,
              "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
            },
            "binding_evidence": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "type",
                "verified_at",
                "valid_until",
                "reference"
              ],
              "properties": {
                "type": {
                  "enum": [
                    "PREVIOUSLY_VERIFIED_BINDING",
                    "BANK_PROVIDER_CONFIRMATION",
                    "CUSTOMER_CONFIRMATION",
                    "CHALLENGE"
                  ]
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When the caller or provider verified the binding."
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Expiry of the caller/provider evidence; must be in the future."
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200,
                  "description": "Non-secret reference to the evidence held by the caller."
                }
              }
            }
          }
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      },
      "required": [
        "country",
        "invoice",
        "payee",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "US"
        },
        "schema_version": {
          "const": "1.0.0"
        },
        "policy_id": {
          "const": "US_INVOICE_PAYEE_VERIFICATION_V1"
        },
        "subject": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "jurisdiction"
          ],
          "anyOf": [
            {
              "required": [
                "entity_id"
              ]
            },
            {
              "required": [
                "identifier"
              ]
            }
          ],
          "properties": {
            "entity_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "identifier": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "type",
                "value"
              ],
              "properties": {
                "type": {
                  "enum": [
                    "STATE_ENTITY_NUMBER",
                    "UEI",
                    "CAGE",
                    "NPI",
                    "USDOT",
                    "MC",
                    "CIK",
                    "LEI",
                    "EIN"
                  ]
                },
                "value": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                },
                "jurisdiction": {
                  "type": "string",
                  "pattern": "^US-[A-Z]{2}$"
                }
              }
            },
            "legal_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "jurisdiction": {
              "type": "string",
              "pattern": "^US-[A-Z]{2}$"
            },
            "country": {
              "const": "US",
              "default": "US"
            }
          }
        },
        "invoice": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "invoice_id",
            "invoice_number",
            "issue_date",
            "currency",
            "total_amount",
            "supplier_legal_name"
          ],
          "properties": {
            "invoice_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "invoice_number": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "issue_date": {
              "type": "string",
              "format": "date"
            },
            "due_date": {
              "type": "string",
              "format": "date"
            },
            "currency": {
              "type": "string",
              "pattern": "^[A-Za-z]{3}$"
            },
            "total_amount": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
            },
            "supplier_legal_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "supplier_identifiers": {
              "type": "array",
              "maxItems": 20,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "type",
                  "value"
                ],
                "properties": {
                  "type": {
                    "enum": [
                      "STATE_ENTITY_NUMBER",
                      "UEI",
                      "CAGE",
                      "NPI",
                      "USDOT",
                      "MC",
                      "CIK",
                      "LEI",
                      "EIN"
                    ]
                  },
                  "value": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 160
                  },
                  "jurisdiction": {
                    "type": "string",
                    "pattern": "^US-[A-Z]{2}$"
                  }
                }
              },
              "default": []
            },
            "billing_address": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "line1",
                "locality",
                "subdivision",
                "postal_code",
                "country"
              ],
              "properties": {
                "line1": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "line2": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "locality": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120
                },
                "subdivision": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 80
                },
                "postal_code": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 24
                },
                "country": {
                  "const": "US"
                }
              }
            },
            "remittance_information": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "legal_name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "address": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "line1",
                    "locality",
                    "subdivision",
                    "postal_code",
                    "country"
                  ],
                  "properties": {
                    "line1": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "line2": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "locality": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "subdivision": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 80
                    },
                    "postal_code": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 24
                    },
                    "country": {
                      "const": "US"
                    }
                  }
                },
                "opaque_reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              }
            },
            "purchase_order": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "customer_identity": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "legal_name"
              ],
              "properties": {
                "legal_name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "identifier": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 160
                }
              }
            },
            "document_digest": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "metadata": {
              "type": "object",
              "maxProperties": 30,
              "additionalProperties": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null"
                ],
                "maxLength": 500
              }
            }
          }
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "value"
          ],
          "properties": {
            "type": {
              "enum": [
                "X402_PAYTO",
                "WALLET",
                "MERCHANT_RESOURCE",
                "PAYOUT_DESTINATION_TOKEN",
                "PROVIDER_ACCOUNT_TOKEN"
              ]
            },
            "value": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            },
            "provider_namespace": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            }
          }
        },
        "payee_evidence": {
          "type": "array",
          "maxItems": 30,
          "default": [],
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "assertion_id",
              "type",
              "claim_classification",
              "evidence_digest"
            ],
            "properties": {
              "assertion_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              },
              "type": {
                "enum": [
                  "OFFICIAL_RECORD",
                  "CALLER_PROVIDED_DOCUMENT",
                  "MERCHANT_ASSERTION",
                  "SUPPLIER_ASSERTION",
                  "INDEPENDENT_CONFIRMATION",
                  "PROVIDER_ATTESTATION",
                  "SIGNED_WALLET_CHALLENGE"
                ]
              },
              "claim_classification": {
                "enum": [
                  "OBSERVED_FACT",
                  "NORMALIZED_FACT",
                  "INFERENCE",
                  "POLICY_OUTCOME"
                ]
              },
              "evidence_digest": {
                "type": "string",
                "pattern": "^sha256:[0-9a-f]{64}$"
              },
              "observed_at": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "payee_challenge": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "method"
          ],
          "properties": {
            "challenge_reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "challenge_digest": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "method": {
              "enum": [
                "PROVIDER_ATTESTATION",
                "SIGNED_WALLET_CHALLENGE"
              ]
            }
          }
        },
        "payment_context": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "amount_band"
          ],
          "properties": {
            "amount_band": {
              "enum": [
                "MICRO",
                "LOW",
                "MEDIUM",
                "HIGH",
                "VERY_HIGH"
              ]
            },
            "destination_changed": {
              "type": "boolean",
              "default": false
            },
            "duplicate_invoice_indicator": {
              "type": "boolean",
              "default": false
            },
            "purchase_order_required": {
              "type": "boolean",
              "default": false
            }
          }
        },
        "supplier_approval_token": {
          "type": "string",
          "minLength": 32,
          "maxLength": 8192
        }
      },
      "required": [
        "country",
        "schema_version",
        "policy_id",
        "subject",
        "invoice",
        "payee",
        "payment_context"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB",
    "US"
  ]
}

authorize_payment

Global RunOnProof tool. Choose country from BR, GB, US; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB",
        "US"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "supplier": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "cnpj": {
              "type": "string",
              "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
            },
            "policy_id": {
              "const": "BR_SUPPLIER_APPROVAL_V1"
            },
            "payee": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "cnpj": {
                  "type": "string",
                  "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
                },
                "payee_fingerprint": {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                },
                "binding_evidence": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "type": {
                      "enum": [
                        "PROVIDER_ATTESTATION",
                        "INDEPENDENT_CONFIRMATION",
                        "SIGNED_CHALLENGE",
                        "PREVIOUSLY_VERIFIED_BINDING"
                      ]
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 240
                    },
                    "verified_at": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "valid_until": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "subject_cnpj": {
                      "type": "string",
                      "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
                    },
                    "payee_fingerprint": {
                      "type": "string",
                      "pattern": "^sha256:[0-9a-f]{64}$"
                    }
                  },
                  "required": [
                    "type",
                    "reference",
                    "verified_at",
                    "valid_until",
                    "subject_cnpj",
                    "payee_fingerprint"
                  ]
                }
              },
              "required": [
                "cnpj",
                "payee_fingerprint"
              ]
            }
          },
          "required": [
            "cnpj",
            "policy_id"
          ]
        },
        "invoice": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "invoice_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            },
            "supplier_cnpj": {
              "type": "string",
              "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
            },
            "supplier_legal_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            },
            "supplier_address": {
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            },
            "issue_date": {
              "type": "string",
              "format": "date"
            },
            "amount": {
              "type": "string",
              "pattern": "^\\d{1,18}(?:\\.\\d{1,6})?$"
            },
            "currency": {
              "const": "BRL",
              "default": "BRL"
            }
          },
          "required": [
            "invoice_id",
            "supplier_cnpj",
            "supplier_legal_name"
          ]
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "cnpj": {
              "type": "string",
              "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
            },
            "payee_fingerprint": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "binding_evidence": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "enum": [
                    "PROVIDER_ATTESTATION",
                    "INDEPENDENT_CONFIRMATION",
                    "SIGNED_CHALLENGE",
                    "PREVIOUSLY_VERIFIED_BINDING"
                  ]
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 240
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time"
                },
                "subject_cnpj": {
                  "type": "string",
                  "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
                },
                "payee_fingerprint": {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                }
              },
              "required": [
                "type",
                "reference",
                "verified_at",
                "valid_until",
                "subject_cnpj",
                "payee_fingerprint"
              ]
            }
          },
          "required": [
            "cnpj",
            "payee_fingerprint"
          ]
        },
        "vendor_change": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "cnpj": {
              "type": "string",
              "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
            },
            "current_payee_fingerprint": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "proposed_payee_fingerprint": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "prior_authorization": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "execution_id": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 240
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time"
                },
                "status": {
                  "enum": [
                    "AUTHORIZED",
                    "AUTHORIZED_WITH_LIMITS"
                  ]
                }
              },
              "required": [
                "execution_id",
                "valid_until",
                "status"
              ]
            },
            "challenge": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "enum": [
                    "PROVIDER_ATTESTATION",
                    "INDEPENDENT_CONFIRMATION",
                    "SIGNED_CHALLENGE",
                    "PREVIOUSLY_VERIFIED_BINDING"
                  ]
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 240
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time"
                },
                "subject_cnpj": {
                  "type": "string",
                  "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
                },
                "payee_fingerprint": {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                }
              },
              "required": [
                "type",
                "reference",
                "verified_at",
                "valid_until",
                "subject_cnpj",
                "payee_fingerprint"
              ]
            }
          },
          "required": [
            "cnpj",
            "current_payee_fingerprint",
            "proposed_payee_fingerprint",
            "prior_authorization"
          ]
        },
        "amount": {
          "type": "string",
          "pattern": "^\\d{1,18}(?:\\.\\d{1,6})?$"
        },
        "currency": {
          "const": "BRL"
        },
        "policy_id": {
          "const": "BR_PAYMENT_AUTHORIZATION_V1"
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "supplier",
        "invoice",
        "payee",
        "amount",
        "currency",
        "policy_id",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        },
        "company_number": {
          "type": "string",
          "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
          "description": "Companies House company number, including any two-letter prefix when applicable."
        },
        "supplier": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number",
            "policy_id"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "policy_id": {
              "type": "string",
              "minLength": 3,
              "maxLength": 120,
              "description": "Declared onboarding policy, normally GB_NEW_SUPPLIER_V1."
            },
            "sanctions_subject_names": {
              "type": "array",
              "maxItems": 25,
              "uniqueItems": true,
              "items": {
                "type": "string",
                "minLength": 3,
                "maxLength": 300
              }
            },
            "vat_number": {
              "type": "string",
              "maxLength": 20
            },
            "eori_number": {
              "type": "string",
              "maxLength": 30
            },
            "payee": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "company_number",
                "payee_fingerprint"
              ],
              "properties": {
                "company_number": {
                  "type": "string",
                  "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
                  "description": "Companies House company number, including any two-letter prefix when applicable."
                },
                "payee_fingerprint": {
                  "type": "string",
                  "minLength": 8,
                  "maxLength": 200,
                  "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
                },
                "binding_evidence": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "type",
                    "verified_at",
                    "valid_until",
                    "reference"
                  ],
                  "properties": {
                    "type": {
                      "enum": [
                        "PREVIOUSLY_VERIFIED_BINDING",
                        "BANK_PROVIDER_CONFIRMATION",
                        "CUSTOMER_CONFIRMATION",
                        "CHALLENGE"
                      ]
                    },
                    "verified_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "When the caller or provider verified the binding."
                    },
                    "valid_until": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Expiry of the caller/provider evidence; must be in the future."
                    },
                    "reference": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200,
                      "description": "Non-secret reference to the evidence held by the caller."
                    }
                  }
                }
              }
            }
          }
        },
        "invoice": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "invoice_company_name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 300,
              "description": "Legal name printed on the invoice."
            },
            "invoice_address": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "line_1": {
                  "type": "string",
                  "maxLength": 300
                },
                "line_2": {
                  "type": "string",
                  "maxLength": 300
                },
                "locality": {
                  "type": "string",
                  "maxLength": 200
                },
                "postal_code": {
                  "type": "string",
                  "maxLength": 20
                },
                "country": {
                  "type": "string",
                  "maxLength": 80
                }
              }
            },
            "vat_number": {
              "type": "string",
              "maxLength": 20,
              "description": "Optional UK VAT number; this route does not independently verify VAT registration."
            }
          }
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number",
            "payee_fingerprint"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "payee_fingerprint": {
              "type": "string",
              "minLength": 8,
              "maxLength": 200,
              "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
            },
            "binding_evidence": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "type",
                "verified_at",
                "valid_until",
                "reference"
              ],
              "properties": {
                "type": {
                  "enum": [
                    "PREVIOUSLY_VERIFIED_BINDING",
                    "BANK_PROVIDER_CONFIRMATION",
                    "CUSTOMER_CONFIRMATION",
                    "CHALLENGE"
                  ]
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When the caller or provider verified the binding."
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Expiry of the caller/provider evidence; must be in the future."
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200,
                  "description": "Non-secret reference to the evidence held by the caller."
                }
              }
            }
          }
        },
        "vendor_change": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "company_number",
            "current_payee_fingerprint",
            "proposed_payee_fingerprint",
            "prior_authorization_reference",
            "challenge",
            "idempotency_key"
          ],
          "properties": {
            "company_number": {
              "type": "string",
              "pattern": "^(?:(?:[A-Z]{2}|[0-9]{2})?[0-9]{6}|[0-9]{8})$",
              "description": "Companies House company number, including any two-letter prefix when applicable."
            },
            "current_payee_fingerprint": {
              "type": "string",
              "minLength": 8,
              "maxLength": 200,
              "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
            },
            "proposed_payee_fingerprint": {
              "type": "string",
              "minLength": 8,
              "maxLength": 200,
              "description": "Opaque caller-generated fingerprint; never send raw bank-account details."
            },
            "prior_authorization_reference": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "description": "Reference to the currently approved vendor/payee binding."
            },
            "challenge": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "type",
                "verified_at",
                "valid_until",
                "reference"
              ],
              "properties": {
                "type": {
                  "enum": [
                    "PREVIOUSLY_VERIFIED_BINDING",
                    "BANK_PROVIDER_CONFIRMATION",
                    "CUSTOMER_CONFIRMATION",
                    "CHALLENGE"
                  ]
                },
                "verified_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When the caller or provider verified the binding."
                },
                "valid_until": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Expiry of the caller/provider evidence; must be in the future."
                },
                "reference": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200,
                  "description": "Non-secret reference to the evidence held by the caller."
                }
              }
            },
            "idempotency_key": {
              "type": "string",
              "pattern": "^[A-Za-z0-9._:-]{8,120}$",
              "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
            }
          }
        },
        "amount": {
          "type": "string",
          "pattern": "^\\d+(?:\\.\\d{1,2})?$",
          "description": "Positive decimal payment amount in the declared currency; not the x402 fee."
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$",
          "description": "ISO 4217 currency code for the business payment instruction."
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$",
          "description": "Caller-generated key. Send the identical value in the Idempotency-Key header."
        }
      },
      "required": [
        "country",
        "company_number",
        "supplier",
        "invoice",
        "payee",
        "amount",
        "currency",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "US"
        },
        "schema_version": {
          "const": "1.0.0"
        },
        "policy_id": {
          "const": "US_PAYMENT_AUTHORIZATION_V1"
        },
        "payment_instruction": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "instruction_id",
            "instruction_digest"
          ],
          "properties": {
            "instruction_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "instruction_digest": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "purpose": {
              "type": "string",
              "minLength": 1,
              "maxLength": 300
            }
          }
        },
        "invoice_verification": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "execution_id",
            "decision_digest"
          ],
          "properties": {
            "execution_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "decision_digest": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            }
          }
        },
        "supplier_approval_token": {
          "type": "string",
          "minLength": 32,
          "maxLength": 8192
        },
        "supplier": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "entity_id",
            "jurisdiction"
          ],
          "properties": {
            "entity_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            "jurisdiction": {
              "type": "string",
              "pattern": "^US-[A-Z]{2}$"
            }
          }
        },
        "payee": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "value"
          ],
          "properties": {
            "type": {
              "enum": [
                "X402_PAYTO",
                "WALLET",
                "MERCHANT_RESOURCE",
                "PAYOUT_DESTINATION_TOKEN",
                "PROVIDER_ACCOUNT_TOKEN"
              ]
            },
            "value": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            },
            "provider_namespace": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            }
          }
        },
        "amount": {
          "type": "string",
          "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$"
        },
        "payment_destination": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type",
            "value"
          ],
          "properties": {
            "type": {
              "enum": [
                "X402_PAYTO",
                "WALLET",
                "MERCHANT_RESOURCE",
                "PAYOUT_DESTINATION_TOKEN",
                "PROVIDER_ACCOUNT_TOKEN"
              ]
            },
            "value": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            },
            "provider_namespace": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            }
          }
        },
        "jurisdiction": {
          "type": "string",
          "pattern": "^US-[A-Z]{2}$"
        },
        "limits": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "amount_band"
          ],
          "properties": {
            "amount_band": {
              "enum": [
                "MICRO",
                "LOW",
                "MEDIUM",
                "HIGH",
                "VERY_HIGH"
              ]
            },
            "limit_amount": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,17})(\\.[0-9]{1,6})?$"
            },
            "destination_changed": {
              "type": "boolean",
              "default": false
            },
            "approval_required": {
              "type": "boolean",
              "default": false
            }
          }
        }
      },
      "required": [
        "country",
        "schema_version",
        "policy_id",
        "payment_instruction",
        "invoice_verification",
        "supplier_approval_token",
        "supplier",
        "payee",
        "amount",
        "currency",
        "payment_destination",
        "jurisdiction",
        "limits"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB",
    "US"
  ]
}

authorize_vendor_payment_detail_change

Global RunOnProof tool. Choose country from US; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters11

country	any	required
schema_version	any	required
supplier	object	required
prior_authorization	object	required
passport_ref	object	required
current_payee	object	required
proposed_payee	object	required
change_reason	enum	required
current_context	object	required
policy_id	any	required
idempotency_key	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "const": "US"
    },
    "schema_version": {
      "const": "1.0.0"
    },
    "supplier": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "entity_id",
        "jurisdiction",
        "relationship",
        "tenant_scope_fingerprint",
        "caller_scope_fingerprint",
        "supplier_master_reference"
      ],
      "properties": {
        "entity_id": {
          "type": "string",
          "pattern": "^(?:usent|ent)_[A-Za-z0-9._:-]{6,150}$"
        },
        "jurisdiction": {
          "type": "string",
          "pattern": "^US-[A-Z]{2}$"
        },
        "relationship": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        },
        "tenant_scope_fingerprint": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "caller_scope_fingerprint": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "supplier_master_reference": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        }
      }
    },
    "prior_authorization": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "kind",
        "reference_id"
      ],
      "properties": {
        "kind": {
          "enum": [
            "SUPPLIER_APPROVAL_TOKEN",
            "CONTINUE_VENDOR_AUTHORIZATION_TOKEN",
            "PASSPORT_AUTHORIZATION_CLAIM",
            "AUTHORIZATION_ID",
            "EXECUTION_REFERENCE",
            "VENDOR_CHANGE_AUTHORIZATION"
          ]
        },
        "reference_id": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        },
        "compact_token": {
          "type": "string",
          "minLength": 32,
          "maxLength": 8192
        }
      }
    },
    "passport_ref": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "passport_id",
        "passport_version",
        "passport_digest",
        "authorization_id"
      ],
      "properties": {
        "passport_id": {
          "type": "string",
          "pattern": "^ccp_[0-9a-f]{32}$"
        },
        "passport_version": {
          "type": "integer",
          "minimum": 1
        },
        "passport_digest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "authorization_id": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        }
      }
    },
    "current_payee": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "payee_type",
        "destination_digest",
        "binding_reference",
        "provider_namespace",
        "valid_until",
        "evidence_refs"
      ],
      "properties": {
        "payee_type": {
          "enum": [
            "PAYOUT_DESTINATION_TOKEN",
            "PROVIDER_ACCOUNT_TOKEN",
            "WALLET",
            "PAYTO"
          ]
        },
        "destination_digest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "binding_reference": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        },
        "provider_namespace": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        },
        "valid_until": {
          "type": "string",
          "format": "date-time"
        },
        "evidence_refs": {
          "type": "array",
          "maxItems": 30,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "minLength": 4,
            "maxLength": 160,
            "pattern": "^[A-Za-z0-9._:-]+$"
          }
        }
      }
    },
    "proposed_payee": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "payee_type",
        "destination_digest",
        "binding_reference",
        "provider_namespace",
        "valid_until",
        "evidence_refs"
      ],
      "properties": {
        "payee_type": {
          "enum": [
            "PAYOUT_DESTINATION_TOKEN",
            "PROVIDER_ACCOUNT_TOKEN",
            "WALLET",
            "PAYTO"
          ]
        },
        "destination_digest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        },
        "binding_reference": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        },
        "provider_namespace": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        },
        "valid_until": {
          "type": "string",
          "format": "date-time"
        },
        "evidence_refs": {
          "type": "array",
          "maxItems": 30,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "minLength": 4,
            "maxLength": 160,
            "pattern": "^[A-Za-z0-9._:-]+$"
          }
        }
      }
    },
    "change_reason": {
      "enum": [
        "SUPPLIER_REQUEST",
        "ACCOUNT_REPLACEMENT",
        "PROCESSOR_MIGRATION",
        "WALLET_ROTATION",
        "PAYTO_CHANGE",
        "PAYOUT_DESTINATION_CHANGE",
        "MERGER_OR_REORGANIZATION",
        "ERROR_CORRECTION",
        "SECURITY_INCIDENT",
        "OTHER_SUPPORTED_REASON"
      ]
    },
    "current_context": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "environment",
        "audience",
        "requested_action",
        "amount",
        "spend_band",
        "currency",
        "invoice_reference",
        "purchase_order",
        "relationship",
        "requested_validity_seconds",
        "independent_confirmation",
        "dual_control",
        "supplier_master_payee_digest",
        "invoice_payee_digest",
        "legal_status",
        "restricted_party_status",
        "coverage_status",
        "source_health_status",
        "evidence_complete",
        "policy_context_digest"
      ],
      "properties": {
        "environment": {
          "enum": [
            "staging",
            "production",
            "test"
          ]
        },
        "audience": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        },
        "requested_action": {
          "const": "UPDATE_VENDOR_PAYEE"
        },
        "amount": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^\\d{1,18}(?:\\.\\d{1,6})?$"
            },
            {
              "type": "null"
            }
          ]
        },
        "spend_band": {
          "enum": [
            "MICRO",
            "LOW",
            "MEDIUM",
            "HIGH",
            "VERY_HIGH"
          ]
        },
        "currency": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[A-Z]{3}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "invoice_reference": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            {
              "type": "null"
            }
          ]
        },
        "purchase_order": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 160
            },
            {
              "type": "null"
            }
          ]
        },
        "relationship": {
          "type": "string",
          "minLength": 4,
          "maxLength": 160,
          "pattern": "^[A-Za-z0-9._:-]+$"
        },
        "requested_validity_seconds": {
          "enum": [
            900,
            3600,
            14400,
            86400
          ]
        },
        "independent_confirmation": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "status",
            "evidence_digest"
          ],
          "properties": {
            "status": {
              "enum": [
                "CONFIRMED",
                "MISSING",
                "FAILED"
              ]
            },
            "evidence_digest": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        },
        "dual_control": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "status",
            "approver_count",
            "evidence_digest"
          ],
          "properties": {
            "status": {
              "enum": [
                "APPROVED",
                "MISSING",
                "REJECTED"
              ]
            },
            "approver_count": {
              "type": "integer",
              "minimum": 0,
              "maximum": 10
            },
            "evidence_digest": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        },
        "supplier_master_payee_digest": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "invoice_payee_digest": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "legal_status": {
          "enum": [
            "ACTIVE",
            "INACTIVE",
            "BLOCKED",
            "UNKNOWN"
          ]
        },
        "restricted_party_status": {
          "enum": [
            "NO_MATCH_FOUND",
            "POSSIBLE_MATCH",
            "CONFIRMED_MATCH",
            "INSUFFICIENT_EVIDENCE"
          ]
        },
        "coverage_status": {
          "enum": [
            "SUFFICIENT",
            "LIMITED",
            "INSUFFICIENT"
          ]
        },
        "source_health_status": {
          "enum": [
            "HEALTHY",
            "DEGRADED",
            "STALE",
            "UNAVAILABLE"
          ]
        },
        "evidence_complete": {
          "type": "boolean"
        },
        "policy_context_digest": {
          "type": "string",
          "pattern": "^sha256:[0-9a-f]{64}$"
        }
      }
    },
    "policy_id": {
      "const": "US_VENDOR_PAYMENT_DETAIL_CHANGE_V1"
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^idem_[A-Za-z0-9._:-]{4,110}$"
    }
  },
  "required": [
    "country",
    "schema_version",
    "supplier",
    "prior_authorization",
    "passport_ref",
    "current_payee",
    "proposed_payee",
    "change_reason",
    "current_context",
    "policy_id",
    "idempotency_key"
  ],
  "additionalProperties": false
}

continue_vendor

Global RunOnProof tool. Choose country from BR, GB, US; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB",
        "US"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "previous_authorization": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "execution_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            },
            "status": {
              "enum": [
                "AUTHORIZED",
                "AUTHORIZED_WITH_LIMITS",
                "SUSPENDED",
                "REVOKED"
              ]
            },
            "valid_until": {
              "type": "string",
              "format": "date-time"
            },
            "claims": {
              "type": "array",
              "minItems": 1,
              "maxItems": 50,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "claim_id": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 240
                  },
                  "type": {
                    "enum": [
                      "LEGAL_ENTITY",
                      "LEGAL_STATUS",
                      "RESTRICTED_PARTY",
                      "PAYEE_BINDING",
                      "SUPPLIER_APPROVAL"
                    ]
                  },
                  "status": {
                    "enum": [
                      "VALID",
                      "STALE",
                      "REVOKED"
                    ]
                  },
                  "valid_until": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "evidence_digest": {
                    "type": "string",
                    "pattern": "^sha256:[0-9a-f]{64}$"
                  }
                },
                "required": [
                  "claim_id",
                  "type",
                  "status",
                  "valid_until",
                  "evidence_digest"
                ]
              }
            }
          },
          "required": [
            "execution_id",
            "status",
            "valid_until",
            "claims"
          ]
        },
        "changed_claims": {
          "type": "array",
          "maxItems": 50,
          "default": [],
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "policy_id": {
          "const": "BR_CONTINUE_VENDOR_AUTHORIZATION_V1"
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "previous_authorization",
        "policy_id",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        }
      },
      "required": [
        "country"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "US"
        },
        "schema_version": {
          "const": "1.0.0"
        },
        "prior_authorization": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "reference_id"
          ],
          "properties": {
            "kind": {
              "enum": [
                "SUPPLIER_APPROVAL_TOKEN",
                "SUPPLIER_APPROVAL_EXECUTION",
                "PASSPORT_AUTHORIZATION_CLAIM",
                "DECISION_REFERENCE",
                "AUTHORIZATION_ID"
              ]
            },
            "reference_id": {
              "type": "string",
              "minLength": 6,
              "maxLength": 160,
              "pattern": "^[A-Za-z0-9._:-]+$"
            },
            "compact_token": {
              "type": "string",
              "minLength": 32,
              "maxLength": 8192
            }
          }
        },
        "passport_ref": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "passport_id",
            "passport_version",
            "passport_digest",
            "authorization_id"
          ],
          "properties": {
            "passport_id": {
              "type": "string",
              "pattern": "^ccp_[0-9a-f]{32}$"
            },
            "passport_version": {
              "type": "integer",
              "minimum": 1
            },
            "passport_digest": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "authorization_id": {
              "type": "string",
              "minLength": 6,
              "maxLength": 160,
              "pattern": "^[A-Za-z0-9._:-]+$"
            }
          }
        },
        "supplier": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "entity_id",
            "jurisdiction",
            "relationship",
            "tenant_scope_fingerprint",
            "caller_scope_fingerprint"
          ],
          "properties": {
            "entity_id": {
              "type": "string",
              "pattern": "^(?:usent|ent)_[A-Za-z0-9._:-]{6,150}$"
            },
            "jurisdiction": {
              "type": "string",
              "pattern": "^US-[A-Z]{2}$"
            },
            "relationship": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "tenant_scope_fingerprint": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "caller_scope_fingerprint": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            }
          }
        },
        "current_action": {
          "enum": [
            "USE_SUPPLIER",
            "ACCEPT_INVOICE",
            "USE_PAYEE",
            "AUTHORIZE_PAYMENT",
            "CONTINUE_RECURRING_RELATIONSHIP"
          ]
        },
        "current_context": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "environment",
            "audience",
            "legal_status",
            "restricted_party_status",
            "payee_digest",
            "destination_digest",
            "spend_band",
            "amount",
            "currency",
            "evidence_digest",
            "evidence_valid_until",
            "coverage_status",
            "source_health_status",
            "changed_fields",
            "requested_validity_seconds"
          ],
          "properties": {
            "environment": {
              "enum": [
                "staging",
                "production",
                "test"
              ]
            },
            "audience": {
              "type": "string",
              "minLength": 6,
              "maxLength": 160,
              "pattern": "^[A-Za-z0-9._:-]+$"
            },
            "legal_status": {
              "enum": [
                "ACTIVE",
                "INACTIVE",
                "BLOCKED",
                "UNKNOWN"
              ]
            },
            "restricted_party_status": {
              "enum": [
                "NO_MATCH_FOUND",
                "POSSIBLE_MATCH",
                "CONFIRMED_MATCH",
                "INSUFFICIENT_EVIDENCE"
              ]
            },
            "payee_digest": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "destination_digest": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^sha256:[0-9a-f]{64}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "spend_band": {
              "enum": [
                "LOW",
                "MEDIUM",
                "HIGH",
                "ENTERPRISE"
              ]
            },
            "amount": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^\\d{1,18}(?:\\.\\d{1,6})?$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "currency": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Z]{3}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "evidence_digest": {
              "type": "string",
              "pattern": "^sha256:[0-9a-f]{64}$"
            },
            "evidence_valid_until": {
              "type": "string",
              "format": "date-time"
            },
            "coverage_status": {
              "enum": [
                "SUFFICIENT",
                "LIMITED",
                "INSUFFICIENT"
              ]
            },
            "source_health_status": {
              "enum": [
                "HEALTHY",
                "DEGRADED",
                "STALE",
                "UNAVAILABLE"
              ]
            },
            "changed_fields": {
              "type": "array",
              "maxItems": 30,
              "uniqueItems": true,
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              }
            },
            "requested_validity_seconds": {
              "type": "integer",
              "minimum": 60,
              "maximum": 86400
            }
          }
        },
        "policy_id": {
          "const": "US_CONTINUE_VENDOR_AUTHORIZATION_V1"
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^idem_[A-Za-z0-9._:-]{4,110}$"
        }
      },
      "required": [
        "country",
        "schema_version",
        "prior_authorization",
        "passport_ref",
        "supplier",
        "current_action",
        "current_context",
        "policy_id",
        "idempotency_key"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB",
    "US"
  ]
}

issue_company_passport

Global RunOnProof tool. Choose country from BR, GB; the response preserves country-specific coverage, sources, freshness and limitations. US federal tools are FEDERAL_ONLY and never assert state good standing or the OFAC 50 Percent Rule.

Parameters1

country

enum

optional

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB"
      ]
    }
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "BR"
        },
        "cnpj": {
          "type": "string",
          "pattern": "^(?:\\d{14}|\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2})$"
        },
        "execution_ids": {
          "type": "array",
          "minItems": 1,
          "maxItems": 50,
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          }
        },
        "idempotency_key": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._:-]{8,120}$"
        }
      },
      "required": [
        "country",
        "cnpj",
        "execution_ids",
        "idempotency_key"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "country": {
          "const": "GB"
        }
      },
      "required": [
        "country"
      ]
    }
  ],
  "x-supported-countries": [
    "BR",
    "GB"
  ]
}

verify_company_passport

Verify the current immutable Company Capability Passport without source calls or charge.

Parameters2

country	enum	required
passport_id	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB"
      ]
    },
    "passport_id": {
      "type": "string"
    }
  },
  "required": [
    "country",
    "passport_id"
  ],
  "additionalProperties": false
}

refresh_company_passport

Create a new immutable Passport version from a declared fresh committed execution set; unchanged valid claims remain reusable.

Parameters3

country	enum	required
passport_id	string	required
idempotency_key	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "country": {
      "enum": [
        "BR",
        "GB"
      ]
    },
    "passport_id": {
      "type": "string"
    },
    "idempotency_key": {
      "type": "string"
    }
  },
  "required": [
    "country",
    "passport_id",
    "idempotency_key"
  ],
  "additionalProperties": true
}

io.github.runonproof/cdo — Model Context Protocol (MCP) Server

🛠️ Key Features

🚀 Use Cases

⚡ Developer Benefits

⚠️ Limitations

preflight

capabilities

verify_receipt

verify_passport

decide

counterfactual

refresh

quote

resolve_agent_intent

get_agent_first_portfolio

resolve_uk_legal_entity

verify_uk_company_status

match_uk_invoice_to_company

match_uk_business_payee

approve_uk_supplier

authorize_uk_vendor_payment_detail_change

authorize_uk_business_payment

screen_restricted_business_party

continue_vendor_authorization

build_uk_company_capability_passport

assess_uk_invoice_authenticity_duplication

verify_uk_bank_account_ownership

detect_uk_company_material_change

verify_uk_business_licence

verify_uk_tax_registration

validate_uk_business_document

verify_uk_beneficial_ownership_control

assess_uk_source_evidence_freshness

run_uk_company_check

run_uk_supplier_approval

verify_uk_invoice_and_payee

run_uk_payment_authorization

run_uk_vendor_change_continuous_authorization

resolve_legal_entity

verify_company_status

screen_restricted_party

company_check

approve_supplier

verify_invoice_payee

authorize_payment

authorize_vendor_payment_detail_change

continue_vendor

issue_company_passport

verify_company_passport

refresh_company_passport

Install

Remote endpoint