---
title: "Send Data"
method: POST
path: "/v1/onboarding"
tags: ["Onboarding Services"]
---

# Send Data

`POST /v1/onboarding`

## Request

- Base URL: `https://api-sandbox.koin.com.br`
- URL: `https://api-sandbox.koin.com.br/v1/onboarding`
- Auth: none declared

Receives a new onboarding data.

## Request body

- OnboardingRequest
  - `store` Store, required
    - `name` string, required: Store name, must not contain special characters and is limited to 20 characters, including spaces
    - `countryCode` string, required: Two-letter code as described in the ISO 3166 international standard
    - `documentType` 'CPF' | 'CNPJ', required: Type of the document
    - `document` string, required: Document number
    - `integration` 'api-standard' | 'bis2bis' | 'magento-1' | 'magento-2' | 'poolpay' | 'traycorp' | 'shopify' | 'vale-pay' | 'vtex' | 'woocommerce' | 'wbuy': Integration source
  - `contacts` Contact[], required
    - `contact` string, required: Email address or Phone number
    - `type` 'EMAIL' | 'PHONE', required: Contact type
    - `roles` string[], required: Contact type
  - `payments` Payment[], required
    - `paymentMethod` string[], required: Payment methods
    - `personData` PersonData, required
      - `firstName` string, required: Person first name
      - `lastName` string, required: Person last name
      - `email` string, required: Person email
      - `cpf` string, required: Person cpf
      - `birthDate` string, required: Birthdate
      - `countryCode` string, required: Phone country code
      - `phone` string, required: Phone number
      - `mcc` string, required: Merchant Category Codes. Four-digit number
      - `address` Address, required
        - `address` string, required: Company address
        - `number` string, required: Company street number
        - `cep` string, required: Company cep
      - `revenue` string, required: Person revenue
    - `companyData` CompanyData
      - `name` string, required: Company name
      - `cnpj` string, required: CNPJ
      - `address` Address, required
        - `address` string, required: Company address
        - `number` string, required: Company street number
        - `cep` string, required: Company cep
      - `email` string, required: Company email
      - `countryCode` string, required: Phone country code
      - `phone` string, required: Phone number
      - `mcc` string, required: Merchant Category Codes. Four-digit number
      - `revenue` string, required: Person revenue
    - `transferData` TransferData, required
      - `period` 'D2' | 'D5' | 'D15' | 'D30' | 'FLOW', required: Advance payment period
      - `accountType` 'CACC' | 'SLARY' | 'SVGS' | 'TRAN', required: Account type
      - `account` string, required: Account number
      - `bank` string, required: Name of the person associated with the bank account
      - `code` string, required: Bank code
      - `branch` string, required: Bank branch
      - `documentNumber` string, required: Account document number
      - `documentType` 'CNPJ' | 'CPF', required: Document type
    - `pricing` PricingData[]: Pricing
      - `paymentMethod` 'CARD' | 'PIX', required: Payment method for the pricing configuration
      - `summarized` number, double: Pricing fee
      - `detailed` PricingDetail[]: Pricing detail table
        - `installment` integer, required: Installment
        - `brand` string, required: Card brand
        - `value` number, double, required: Pricing fee
  - `transaction` Transaction, required
    - `referenceId` string, required: Client transaction identifier
    - `callbackUrl` string: Url to send notifications to client

## Response `200`

Onboarding response

- StandardApiResponse
  - `onboardingId` string, required: Onboarding identification
  - `referenceId` string, required: Client transaction identifier
  - `status` 'PENDING' | 'INPROGRESS' | 'ACTIONREQUIRED' | 'COMPLETED' | 'REJECT' | 'CANCELLED', required: Onboarding status
  - `message` string: Information message
  - `credentials` Credentials
    - `storeCode` string, required: Store code
    - `privateKey` string: Authentication key
    - `orgId` string: Fingerprint key
  - `paymentAccounts` PaymentAccount[]
    - `paymentMethod` 'CARD': Payment method for the extract
    - `account` string: Payment account number
    - `evaluatesFraud` boolean: Indicates if the account has antifraud

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/koin/apis/onboarding-api.md) - [All operations](https://skmtc.dev/koin/apis/onboarding-api/llms.txt) - [OpenAPI document](https://skmtc.dev/koin/apis/onboarding-api/revisions/5adb79153066?raw)