> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yativo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Postal Code Format

> The postal code pattern and samples for a country

Check `postal_code` against `validation.rule_regex` before you submit. If `uses_postal_codes` is `false`, the country has no postal codes.


## OpenAPI

````yaml openapi-fiat.yaml GET /postal-codes/{countryCode}
openapi: 3.0.3
info:
  title: Yativo Fiat API
  description: >
    The Yativo Fiat API enables businesses to manage customers, run KYC/KYB,
    send and receive

    cross-border payments, issue virtual accounts and virtual cards, manage
    beneficiaries, and more.


    **Base URLs**

    | Environment | URL |

    |---|---|

    | Production | `https://api.yativo.com/api/v1` |

    | Sandbox | `https://smtp.yativo.com/api/v1` |


    **Authentication**

    Send `X-Api-Key` and `X-Api-Secret` on every request. Create keys in the
    dashboard under

    **Developers → API Keys**. Each key only works from the server IPs listed on
    it (enforced since

    14 October 2026). Keys don't expire and there's no login call or token
    refresh.


    Login tokens (`POST /auth/login` with an Account ID and App Secret, and
    `Authorization: Bearer`)

    have been discontinued and don't work for API requests.


    Endpoints that change how a person signs in (passkeys, two-factor
    authentication, PIN)

    or delete the account can't be called with an API key. Use the dashboard for
    those.

    API keys and IP whitelists can only be managed in the dashboard.


    **Rate limits**

    Per business account: 20 writes (`POST`, `PUT`, `PATCH`, `DELETE`) and 50
    reads (`GET`) a second.

    Some plans set their own limit. Enterprise plans have no general limit.


    **Idempotency**

    Send an `Idempotency-Key` header on every `POST`, `PUT`, `PATCH` and
    `DELETE` request. A retry with

    the same key and body within 60 minutes returns the original response
    without running again.

    Reusing a key with a different body returns `409`.


    **KYC endpoints** are hosted on a separate platform at
    `https://kyc.yativo.com`. They are

    documented here for completeness but use that base URL, not the main API
    base.
  version: 1.0.0
  contact:
    name: Yativo Support
    url: https://yativo.com
servers:
  - url: https://api.yativo.com/api/v1
    description: Production
  - url: https://smtp.yativo.com/api/v1
    description: Sandbox
security:
  - apiKey: []
    apiSecret: []
tags:
  - name: Customers
    description: Create and manage customer profiles.
  - name: KYC / KYB
    description: >
      Identity verification for individual customers (KYC) and business
      customers (KYB).

      Submission endpoints are on `https://kyc.yativo.com/api`.
  - name: KYC Lookups
    description: >
      Lists your KYC and KYB forms need: countries, subdivisions, postal code
      formats, ID types,

      occupations, industries and allowed values. Served from
      `https://kyc.yativo.com/api`.
  - name: Payments & Transfers
    description: Exchange rates, quotes, send money, payout methods, and wallet payouts.
  - name: Deposits
    description: Initiate and retrieve payin deposits.
  - name: Virtual Accounts
    description: Issue and manage virtual bank accounts for customers.
  - name: Wallets
    description: View balances, create wallets, and list wallet payouts.
  - name: Beneficiaries
    description: Manage saved recipients and their payment methods.
  - name: Transactions
    description: List, retrieve, track, and download receipts for all transaction types.
  - name: Virtual Cards
    description: Activate, issue, manage, and terminate prepaid virtual cards.
  - name: Payouts
    description: Single and batch payouts to beneficiaries.
  - name: Currency Swap
    description: Swap balance between your own currency wallets.
  - name: IP Whitelist
    description: Check whether your server's IP can use your API key.
  - name: Account Security
    description: Review sign-in activity on your account.
  - name: Corporate Card Links
    description: >-
      Each corporate card's employee-only page for card details and PIN,
      employee card sign-in, and branding.
  - name: Webhooks
    description: Register and manage webhook endpoints for real-time event notifications.
  - name: Developer
    description: Request logs and webhook event inspection.
paths:
  /postal-codes/{countryCode}:
    get:
      tags:
        - KYC Lookups
      summary: Get Postal Code Format
      description: >
        **Base URL: `https://kyc.yativo.com/api`**


        Whether a country uses postal codes, and the pattern and sample values
        to validate

        `postal_code` before you submit.
      parameters:
        - name: countryCode
          in: path
          required: true
          description: ISO 3166-1 alpha-2 country code.
          schema:
            type: string
            example: US
      responses:
        '200':
          description: Postal code format
          content:
            application/json:
              schema:
                type: object
                properties:
                  country_code:
                    type: string
                    example: US
                  country_name:
                    type: string
                    example: United States
                  uses_postal_codes:
                    type: boolean
                    example: true
                  validation:
                    type: object
                    properties:
                      rule_regex:
                        type: string
                        nullable: true
                        example: /^\d{5}(?:-\d{4})?$/
                      rule_samples:
                        type: array
                        items:
                          type: string
                        example:
                          - '12345'
                          - 12345-6789
                      addressing_pattern:
                        type: string
                        nullable: true
      security: []
      servers:
        - url: https://kyc.yativo.com/api
          description: KYC Platform (production)
        - url: https://kyc-sandbox.yativo.com/api
          description: KYC Platform (sandbox)
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Your API key (`yativo_pk_...`) from Developers → API Keys. Send together
        with X-Api-Secret.
    apiSecret:
      type: apiKey
      in: header
      name: X-Api-Secret
      description: Your API secret (`yativo_sk_...`), shown once when the key is created.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.