alt.bank · AsyncAPI Specification

Altbank Guard Webhooks

Version

View Spec View on GitHub CompanyFintechBankingCredit CardsCard IssuingUnderwritingPaymentsBrazilKYCAsyncAPIWebhooksEvents

AsyncAPI Specification

Raw ↑
generated: '2026-07-17'
method: searched
source: https://developers.altbank.ai/docs/guard-api
spec_type: Webhooks
summary: >-
  The GUARD underwriting API is asynchronous and event-driven at the result
  stage: after a partner submits an underwriting request, alt.bank POSTs the
  scoring result to a partner-provided callback endpoint. The callback URL is
  registered with alt.bank out-of-band prior to using the API.
webhooks:
  - event: underwriting.result
    direction: altbank-to-partner
    transport: https-post
    trigger: >-
      Fired once GUARD finishes scoring an underwriting request previously
      submitted to POST /api/partner/credit/cards/underwritings.
    delivery:
      target: partner-configured callback URL (registered with alt.bank out-of-band)
    payload:
      schema_ref: openapi/altbank-guard-openapi.yml#/components/schemas/UnderwritingResult
      fields:
        - name: riskBand
          description: Score-based risk band (may be -1 under cost-saving policy or when unscoreable).
        - name: score
          description: Model's final score (may be -1 under cost-saving policy or when unscoreable).
        - name: limit
          description: Suggested initial credit line on approval; 0 when not approved; -1 when unscoreable.
notes: >-
  No published AsyncAPI document exists; this captures the documented webhook
  callback surface. The full callback payload schema is behind the partner-gated
  developer portal — only the three documented result fields are modeled.