---
title: "POST /v4/marketplace_app/ctv/onboarding"
method: POST
path: "/v4/marketplace_app/ctv/onboarding"
---

# POST /v4/marketplace_app/ctv/onboarding

`POST /v4/marketplace_app/ctv/onboarding`

## Headers

- `Authorization` string, required

## Request body

- object
  - `merchantId` string, required — Merchant gateway ID
  - `applications` object[], required
    - `serviceId` string, required — This value will always be "ctv"
    - `application` object, required — Information regarding signup for the Customer Token Vault application
      - `merchantLegalName` string, required — Legal business name of the merchant
      - `merchantDbaName` string, required — "Doing Business As" name for the merchant
      - `merchantEmail` string, required — Valid merchant email address
      - `merchantCity` string, required — Merchant’s city that business is located.
      - `merchantCountryCode` string, required — Two-letter country code.
      - `merchantWebsiteUrl` string, required — Merchant's website url. This must be unique for each merchant gateway. If merchants share a URL, making them unique is required (e.g. https://example.com/2 if a merchant is already using the example.com domain).
      - `merchantBusinessId` object, required — Business identification information which is used to identify and sign up merchant for Customer Token Vault
        - `ssn` string — Social Security Number (United States) example: 123-45-6789
        - `ein` string — Employer Identification Number (Tax ID) (United States) example: 12-3456789
        - `acquirerId` string — (must be used with mid) example: 123456
        - `mid` string — merchant identification (must be used acquirerId). example: 123456
        - `abn` string — Australian Business Number (Australia). example: 83123456789
        - `bid` string — Business Identification Number. example: BID123456
        - `bn` string — Canadian Business Number (Canada). 123456789RC0001
        - `brno` string — Malaysian Business Registration Number (Malaysia). example: 1234567
        - `cl` string — Commercial License Number (Qatar). example: 12345678
        - `cln` string — Commercial License Number (Kuwait). example: 987654
        - `corporateNumber` string — Corporate Number (Japan). example: 1234567890123
        - `cnpj` string — (Brazil). example: 12.345.678/0001-95
        - `cr` string — Company Registration Number (Saudi Arabia). example: 1234567890
        - `cuit` string — (Argentina). example: 20-12345678-9
        - `edrpou` string — Unified State Register of Enterprises (Ukraine). example: 12345678
        - `hkbr` string — Hong Kong Business Registration (Hong Kong). example: 12345678-000-01
        - `nationalId` string — National Taxpayer ID (Dominican Republic). example: 001-1234567-8
        - `nzbn` string — New Zealand Business Number (New Zealand). example: 9429031234567
        - `pan` string — Permanent Account Number (India). example: ABCDE1234F
        - `rfc` string — Business ID (Mexico). example: ABC123456T89
        - `rnc` string — National Taxpayer Registry (Dominican Republic). example: 101123456
        - `ruc` string — Single Taxpayer Registry (Peru). example: 20123456789
        - `rut` string — Single Tax Role (Chile / Colombia). example: 12.345.678-9
        - `sin` string — Social Insurance Number (Canada). example: 123-456-789
        - `uen` string — Unique Entity Number (Singapore). example: 201234567W
        - `vat` string — Value-Added Tax Number (EU & various). example: DE123456789
      - `paymentAppId` string, required — Unique v4 UUID for this app instance. You can generate this how you want, but each must be unique to all applications across NMI. Duplicates will result in boarding errors. example: 5487317d-0a22-4d14-9d70-774331f62004
      - `paymentAppLegalName` string, required — Typically the same as the "merchantLegalName" value.
      - `paymentAppDisplayName` string, required — The app that will be using tokens. Something generic like "webApp" will work.

## Response `200`

---

[API](https://skmtc.net/nmi/apis/embedded-components-api.md) · [All operations](https://skmtc.net/nmi/apis/embedded-components-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmi/embedded-components-api/revisions/45c2ecda3685/schema)