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

# Get registration requirements

> Returns what you need to send to register an account of this kind for the organization in the route: the `accountDetails` fields for the identifier kind, and the `registrationInfo` fields the route requires. `registrationInfo.missing` lists the required fields we hold no verified value for, so you ask the customer only for those. Pass the same `kind`, `country`, `currency` and `accountDetails.kind` you would send to register.



## OpenAPI

````yaml openapi-v2.json GET /organization/{organizationId}/payment_account/requirements
openapi: 3.1.0
info:
  title: Etherfuse FX API
  description: >-
    Partner-facing ramp API, version 2: payment accounts, quotes, orders and
    webhooks.
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.sand.etherfuse.com
    description: Sandbox
security:
  - ApiKeyAuth: []
tags:
  - name: Payment Accounts
    description: >-
      Register the bank accounts and wallets that money moves from and to, and
      read their readiness per rail.
  - name: Quotes
    description: Price a transfer between two registered payment accounts.
  - name: Orders
    description: Create orders from quotes and track them.
  - name: Webhook Subscriptions
    description: Subscribe to webhook events.
  - name: Webhook Events
    description: Payloads Etherfuse sends to your webhook subscriptions.
  - name: Sandbox
    description: Endpoints that work only in sandbox, for testing.
  - name: Assets
    description: The markets and tokens a quote can use, and the balances of a wallet.
  - name: Authentication
    description: >-
      Partner JWT authentication: exchange a JWT for an access token, or launch
      a user into the app.
  - name: KYC
    description: >-
      Submit a customer's verification data, documents and questionnaire
      answers, import a verification they already passed elsewhere, and check
      where their KYC stands.
  - name: KYB
    description: Check where a business organization's KYB stands.
  - name: Lookup
    description: >-
      Public reference data: exchange rates, stablebonds, bond costs, country
      codes.
  - name: Organizations
    description: >-
      Your organization, your default partner fee, and the customer
      organizations you create.
  - name: Members
    description: >-
      The people who belong to a customer business organization and complete its
      KYB.
  - name: Statements
    description: >-
      Monthly revenue share statements for closed months, as a list or as a CSV
      or PDF download.
paths:
  /organization/{organizationId}/payment_account/requirements:
    get:
      tags:
        - Payment Accounts
      summary: Get registration requirements
      description: >-
        Returns what you need to send to register an account of this kind for
        the organization in the route: the `accountDetails` fields for the
        identifier kind, and the `registrationInfo` fields the route requires.
        `registrationInfo.missing` lists the required fields we hold no verified
        value for, so you ask the customer only for those. Pass the same `kind`,
        `country`, `currency` and `accountDetails.kind` you would send to
        register.
      operationId: v2GetPaymentAccountRequirements
      parameters:
        - $ref: '#/components/parameters/OrganizationId'
        - name: kind
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/PaymentAccountKind'
        - name: country
          in: query
          required: false
          description: Two-letter country code. Omit for a wallet.
          schema:
            type: string
        - name: currency
          in: query
          required: false
          description: Three-letter currency code. Omit for a wallet.
          schema:
            type: string
        - name: accountDetailsKind
          in: query
          required: true
          description: The `accountDetails.kind` you would register, for example `clabe`.
          schema:
            $ref: '#/components/schemas/AccountDetailsKind'
      responses:
        '200':
          description: The fields to send.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccountRequirements'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/OrganizationNotFound'
        '422':
          description: >-
            `unsupported`: this kind of account, or this identifier in this
            location, cannot be registered. Registration returns the same error
            for the same request.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    OrganizationId:
      name: organizationId
      in: path
      required: true
      description: >-
        The organization this call acts for: your API key's organization or one
        of its customer organizations. Any other id returns `404` `not-found`.
      schema:
        type: string
        format: uuid
  schemas:
    PaymentAccountKind:
      type: string
      enum:
        - bank
        - wallet
        - embeddedWallet
        - debitCard
        - cash
      description: >-
        The kind of account. `embeddedWallet` is a wallet we create on a chain;
        see [Embedded wallets](/v2/guides/embedded-wallets). `debitCard` and
        `cash` return `422` `unsupported`.
    AccountDetailsKind:
      type: string
      enum:
        - clabe
        - pixKey
        - address
        - signerPublicKey
      description: >-
        The kind of identifier that names the account. `signerPublicKey` names
        an `embeddedWallet` account by the P-256 key that controls it.
    PaymentAccountRequirements:
      type: object
      required:
        - accountDetails
        - registrationInfo
      properties:
        accountDetails:
          type: object
          required:
            - kind
            - required
          properties:
            kind:
              type: string
              description: The `accountDetails.kind` you asked about.
            required:
              type: array
              items:
                type: string
              description: >-
                The fields `accountDetails` must carry for this kind, as JSON
                Pointers such as `#/accountDetails/clabe`.
        registrationInfo:
          type: object
          required:
            - required
            - missing
          properties:
            required:
              type: array
              items:
                type: string
              description: >-
                Every registration field the route requires, as JSON Pointers
                such as `#/registrationInfo/taxId`. The same lists as the
                `registration-info-required` error.
            missing:
              type: array
              items:
                type: string
              description: >-
                The required fields we hold no verified value for, as JSON
                Pointers. Ask the customer for these. This list is for
                registering a new account. Registering an account the
                organization already holds may need fewer fields.
    Problem:
      type: object
      description: >-
        RFC 9457 problem details. Every v2 error uses this body with content
        type `application/problem+json`. `errors` is present only on
        `validation-error`. `required` and `missing` are present only on
        `registration-info-required`.
      required:
        - type
        - title
        - status
        - detail
        - instance
      properties:
        type:
          type: string
          format: uri
          description: >-
            `https://docs.etherfuse.com/ramp/v2/errors/` followed by the problem
            slug, for example
            `https://docs.etherfuse.com/ramp/v2/errors/quote-expired`. Switch on
            this value.
          example: https://docs.etherfuse.com/ramp/v2/errors/quote-expired
        title:
          type: string
          description: Short summary of the problem type.
          example: Quote expired
        status:
          type: integer
          description: The HTTP status code.
          example: 400
        detail:
          type: string
          description: Human-readable explanation of this occurrence. Do not parse it.
          example: >-
            quote 5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b has expired or does not
            exist
        instance:
          type: string
          description: Unique identifier for this occurrence. Quote it to support.
          example: >-
            tag:etherfuse.com,2026-08-28:R2-10120/0b1c2d3e-4f50-4a6b-8c7d-9e0f1a2b3c4d
        errors:
          type: array
          description: Present on `validation-error`. One entry per invalid field.
          items:
            $ref: '#/components/schemas/FieldViolation'
        required:
          type: array
          description: >-
            Present on `registration-info-required`. Every registration field
            the route requires, as JSON Pointers into the request, for example
            `#/registrationInfo/taxId`.
          items:
            type: string
        missing:
          type: array
          description: >-
            Present on `registration-info-required`. The required fields you
            must still send, as JSON Pointers into the request.
          items:
            type: string
    FieldViolation:
      type: object
      required:
        - pointer
        - detail
      properties:
        pointer:
          type: string
          description: >-
            JSON Pointer to the field in the request, for example
            `#/accountDetails/clabe`.
          example: '#/accountDetails/clabe'
        detail:
          type: string
          description: What is wrong with the field.
          example: This field is required.
  responses:
    InvalidRequest:
      description: >-
        `invalid-request`: a path, query or body value is malformed, or
        `pageSize` is 0 or over 100.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: >-
        `unauthorized`: the `Authorization` header is missing, not ASCII, or
        does not hold a valid API key.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    OrganizationNotFound:
      description: '`not-found`: your API key cannot act for this organization.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    InternalError:
      description: >-
        `internal-error`: an unexpected error on our side. Retry with backoff,
        and quote `instance` to support if it persists.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key sent in the Authorization header, with no `Bearer` prefix.

````

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