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

# Discover admitted Base account profiles before owner signing



## OpenAPI

````yaml /openapi/platform.json get /v1/yield/onboarding/compatibility
openapi: 3.1.0
info:
  title: GOL Platform API
  description: >-
    Versioned GOL developer and consumer API. Consumer routes are mounted when
    their runtime integrations are configured.
  version: 0.8.0-rc.1
servers:
  - url: http://localhost:4100
    description: Local development
security: []
tags:
  - name: system
  - name: authentication
  - name: projects
  - name: api-keys
  - name: audit
  - name: gas-executions
  - name: gas-policies
  - name: webhooks
paths:
  /v1/yield/onboarding/compatibility:
    get:
      tags:
        - Yield
      summary: Discover admitted Base account profiles before owner signing
      operationId: getYieldCompatibility
      parameters:
        - in: query
          name: chainId
          required: true
          schema:
            type: string
            enum:
              - '8453'
        - in: query
          name: account
          required: true
          schema:
            pattern: ^0x[0-9a-fA-F]{40}$
            type: string
      responses:
        '200':
          description: Compatible profiles and explicit refusals
          content:
            application/json:
              schema:
                type: object
                required:
                  - candidates
                  - refusals
                properties:
                  candidates:
                    type: array
                    items:
                      type: object
                      required:
                        - chainId
                        - account
                        - profileId
                        - lane
                        - supportsBatch
                        - status
                        - accountId
                        - installation
                        - ownerDialect
                      properties:
                        chainId:
                          type: string
                          enum:
                            - '8453'
                        account:
                          pattern: ^0x[0-9a-fA-F]{40}$
                          type: string
                        profileId:
                          pattern: ^0x[0-9a-fA-F]{64}$
                          type: string
                        lane:
                          type: string
                        supportsBatch:
                          type: boolean
                        status:
                          type: string
                          enum:
                            - candidate
                            - active
                            - deprecated
                        accountId:
                          type: string
                        ownerDialect:
                          type: string
                        installation:
                          type: object
                          required:
                            - to
                            - value
                            - data
                          properties:
                            to:
                              pattern: ^0x[0-9a-fA-F]{40}$
                              type: string
                            value:
                              type: string
                              enum:
                                - '0'
                            data:
                              type: string
                              pattern: ^0x(?:[0-9a-fA-F]{2})*$
                  refusals:
                    type: array
                    items:
                      type: object
                      required:
                        - profileId
                        - status
                        - reason
                      properties:
                        profileId:
                          pattern: ^0x[0-9a-fA-F]{64}$
                          type: string
                        status:
                          type: string
                        reason:
                          type: string
        '400':
          description: Malformed or incompatible owner request
        '503':
          description: Yield onboarding adapters are unavailable

````

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