> This page is for Afterpay Partner API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.afterpay.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.afterpay.com/_mcp/server.

### Schema (`response.body`)

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /onboarding-schema:
    get:
      operationId: subpackageOnboardings_getOnboardingSchema
      summary: Onboarding Schema
      tags:
        - subpackage_onboardings
      responses:
        '200':
          description: Onboarding schema
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Onboardings_getOnboardingSchema_Response_200
tags:
  - name: subpackage_onboardings
servers:
  - url: https://agencyapi.afterpay.com
    description: Production
  - url: https://agencyapi.sandbox.afterpay.com
    description: Sandbox
components:
  schemas:
    OnboardingOwnersItems:
      type: object
      properties:
        firstName:
          type: string
          description: >-
            Given name of the primary owner or authorized representative of the
            business; optional for public companies and nonprofits.
        lastName:
          type: string
          description: >-
            Surname name of the primary owner or authorized representative of
            the business; optional for public companies and nonprofits.
        dob:
          type: string
          format: date
          description: Date of birth in YYYY-MM-DD format. Optional.
        taxId:
          type: string
          description: >-
            Tax id of the primary owner or authorized representative of the
            business; optional for public companies and nonprofits. Optional.
        jobTitle:
          type: string
          description: >-
            Job title of the primary owner or authorized representative of the
            business; optional for public companies and nonprofits. Optional.
        owns25:
          type: boolean
          description: Indicates if the owner owns more than 25% of the business. Optional.
        significantResponsibility:
          type: boolean
        address1:
          type: string
          description: Line 1 of address.
        address2:
          type: string
          description: Line 2 of address.
        city:
          type: string
          description: City, town or municipality.
        state:
          type: string
          description: State, region, county, province, or territory.
        postCode:
          type: string
          description: Postal code.
        countryCode:
          type: string
          description: Country code in the two-letter ISO 3166-1 alpha-2 standard format.
      required:
        - firstName
        - lastName
      description: >-
        Personal details of the business owner. This object is optional for
        public companies and nonprofits if the partner chooses to pass the
        business type in the optional businessType field; otherwise, it's
        required.
      title: OnboardingOwnersItems
    Onboarding:
      type: object
      properties:
        onboardingId:
          type: string
          description: >-
            The ID that can be used to update merchant's configs and get an
            onboarding status.
        updatedAt:
          type: string
          description: Last updated timestamp of this onboarding.
        merchantReference:
          type: string
          description: >-
            Unique ID for the merchant in the partner's internal systems to
            index to Afterpay's Merchant ID (MID).
        parentMerchantReference:
          type: string
          description: >-
            Unique ID for the platform of the merchant in the partner's internal
            systems to index to merchantReference.
        legalBusinessName:
          type: string
          description: Legal business name found in incorporation or similar documents.
        storeName:
          type: string
          description: Recognizable doing-business-as name.
        website:
          type: string
          description: Homepage URL of the merchant.
        platform:
          type: string
          description: Platform the merchant is on.
        industry:
          type: string
          description: >-
            A four-digit number that classifies the type of goods or services a
            business offers following the ISO 18245 standard.
        aveTimeToShip:
          type: string
          description: Average time to ship for this business.
        registeredCountry:
          type: string
          description: >-
            Country code in the two-letter ISO 3166-1 alpha-2 standard format
            defining the consumer market where the merchant will sell goods or
            services.
        countryOfOperations:
          type: string
          description: The consumer market where the merchant will sell goods or services.
        businessType:
          type: string
          description: >-
            Type of business matching exactly the naming conventions outlined in
            the business type section.
        ein:
          type: string
          description: >-
            Identifying tax number such as TIN, ABN, or SSN depending on the
            relevant jurisdiction. Can be null.
        selfFulfillment:
          type: boolean
          description: Indicates if the merchant fulfills orders themselves.
        address1:
          type: string
          description: Business address 1 of the merchant.
        address2:
          type: string
          description: Business address 2 of the merchant, if applicable. Can be null.
        city:
          type: string
          description: City of the business address of the merchant.
        state:
          type: string
          description: State or province of the business address of the merchant.
        postCode:
          type: string
          description: Postal code of the business address of the merchant.
        email:
          type: string
          description: >-
            Customer support email that will be shown within the Afterpay native
            application.
        settlementContractId:
          type: string
          description: >-
            Defines the country and the banking entity for the partner's online
            channel for the benefit of the merchant.
        owners:
          type: array
          items:
            $ref: '#/components/schemas/OnboardingOwnersItems'
      title: Onboarding
    Onboardings_getOnboardingSchema_Response_200:
      type: object
      properties:
        onboarding:
          $ref: '#/components/schemas/Onboarding'
      required:
        - onboarding
      title: Onboardings_getOnboardingSchema_Response_200

```

**`Example`**

```json Example
{
  "onboardingId": "123abcd-456efgh-1124bd",
  "updatedAt": "2024-02-21T09:50:36.871+00:00",
  "merchantReference": "merchantId123",
  "parentMerchantReference": "merchantPlatform",
  "legalBusinessName": "merchantBusiness",
  "storeName": "merchantName",
  "website": "https://www.testmerchant.com",
  "platform": "BLOCK",
  "industry": "8299",
  "aveTimeToShip": "Less than 1 Week",
  "registeredCountry": "US",
  "countryOfOperations": "US",
  "businessType": "corporation",
  "ein": "string",
  "selfFulfillment": true,
  "address1": "123 Main St",
  "address2": "string",
  "city": "London",
  "state": "CA",
  "postCode": "12345",
  "email": "youremail@testmerchant.com",
  "settlementContractId": "1a2b3c4d5e12xy34z",
  "owners": [
    {
      "firstName": "Sam",
      "lastName": "Merchant",
      "dob": "2023-02-21",
      "taxId": "TaxId123",
      "jobTitle": "CEO",
      "owns25": true,
      "significantResponsibility": false,
      "address1": "123 Main St",
      "address2": "Apt 1403",
      "city": "New York",
      "state": "NY",
      "postCode": "10011",
      "countryCode": "US"
    }
  ]
}
```