---
title: "Get counterparty ramp requirements"
method: GET
path: "/v1/counterparties/{counterpartyId}/requirements"
tags: ["Counterparties"]
---

# Get counterparty ramp requirements

`GET /v1/counterparties/{counterpartyId}/requirements`

Evaluates whether a counterparty is ready to create a quote with the selected ramp provider and returns any fields or provider-hosted actions still required.

## Path parameters

- `counterpartyId` string, required — Counterparty identifier.

## Query parameters

- `provider` union, required — Ramp provider to evaluate.
  - 'moonpay' | 'lightspark' | 'bvnk' | 'moneygram' | 'coinbase' | 'mural' | 'stripe'
  - 'moonpay' | 'lightspark' | 'bvnk' | 'moneygram' | 'mural'
- `direction` 'onramp' | 'offramp', required — Ramp direction.
- `cryptoToken` string, required — Crypto asset symbol.
- `fiatCurrency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW', required — Fiat currency code.
- `destinationWallet` string — Destination wallet ID. Required when direction is onramp.

## Headers

- `x-project-id` string — Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

## Response `200`

Counterparty ramp requirements

- object — Standard success response envelope.
  - `data` union, required — Current provider-specific readiness state and any fields or actions required before creating a ramp quote.
    - object
      - `direction` 'onramp' | 'offramp', required — Ramp direction evaluated for this counterparty.
      - `provider` 'moonpay' | 'lightspark' | 'bvnk' | 'moneygram' | 'coinbase' | 'mural' | 'stripe', required
      - `status` 'ready', required
    - object
      - `direction` 'onramp' | 'offramp', required — Ramp direction evaluated for this counterparty.
      - `provider` 'moonpay' | 'lightspark' | 'bvnk' | 'moneygram' | 'coinbase' | 'mural' | 'stripe', required
      - `status` 'collect', required
      - `fields` union[], required
        - union
          - object
            - `kind` 'text', required
            - `key` string, required
            - `label` string, required
            - `required` boolean, required
            - `pattern` string
            - `minLength` integer
            - `maxLength` integer
            - `placeholder` string
            - `mask` string
          - object
            - `kind` 'select', required
            - `key` string, required
            - `label` string, required
            - `required` boolean, required
            - `options` object[], required
              - …
    - object
      - `direction` 'onramp' | 'offramp', required — Ramp direction evaluated for this counterparty.
      - `provider` 'moonpay' | 'lightspark' | 'bvnk' | 'moneygram' | 'coinbase' | 'mural' | 'stripe', required
      - `status` 'unsupported', required
      - `reason` string, required
    - object
      - `direction` 'onramp' | 'offramp', required — Ramp direction evaluated for this counterparty.
      - `provider` 'lightspark' | 'bvnk' | 'mural', required
      - `status` 'onboarding_not_started', required
    - object
      - `direction` 'onramp' | 'offramp', required — Ramp direction evaluated for this counterparty.
      - `provider` 'mural', required
      - `status` 'terms_of_service_required', required
      - `termsOfServiceUrl` string, uri, required
    - object
      - `direction` 'onramp' | 'offramp', required — Ramp direction evaluated for this counterparty.
      - `provider` 'bvnk' | 'mural', required
      - `status` 'customer_verification_required', required
      - `verificationUrl` string, uri, required
    - object
      - `direction` 'onramp' | 'offramp', required — Ramp direction evaluated for this counterparty.
      - `provider` 'bvnk' | 'mural', required
      - `status` 'customer_verifying' | 'customer_verification_failed' | 'funding_account_provisioning', required
    - object
      - `direction` 'onramp' | 'offramp', required — Ramp direction evaluated for this counterparty.
      - `provider` 'bvnk', required
      - `status` 'provisioning_failed', required
  - `meta` object, required — Response metadata.
    - `requestId` string, required — Request identifier for tracing.
    - `timestamp` string, date-time, required — ISO 8601 timestamp.

## Other responses

- `400` — Error
- `401` — Error
- `403` — Error
- `404` — Error
- `500` — Error

---

[API](https://skmtc.net/solana/apis/solana-developer-platform-api.md) · [All operations](https://skmtc.net/solana/apis/solana-developer-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/solana/solana-developer-platform-api/revisions/672b1916ba61/schema)