Manage onboarding data

Overview

Onboarding data is a set of required business information about the entities that want to start accepting payments, such as MCC, publicly available website, and terms of service agreement.

Providing the onboarding documents allows the entities to have a seamless onboarding for accepting payments experience with reduced manual labor required.

Provide the onboarding data

To specify the onboarding data for an entity, call PATCH /v1/entities/{entity_id}/onboarding_data:

curl -X PATCH 'https://api.dev.monite.com/v1/entities/aea39...912/onboarding_data' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'Authorization: Bearer ACCESS_TOKEN'
     -H 'Content-Type: application/json' \
     -d '{
    "business_profile": {
      "mcc": "1731",
      "url": "https://mycompany.com"
    },
    "tos_acceptance": {
      "ip": "192.0.2.1",
      "date": "2023-03-21T12:35:57.372Z"
    },
    "ownership_declaration": {
      "ip": "192.0.2.1",
      "date": "2023-05-03T11:27:54.736Z"
    }
  }'

A successful response returns the values received in the request.

Get the onboarding data

To get the data that an entity provided during onboarding, call GET /v1/entities/{entity_id}/onboarding_data:

curl -X GET 'https://api.sandbox.monite.com/v1/entities/aea39...912/onboarding_data' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'Authorization: Bearer ACCESS_TOKEN'

A successful response contains the onboarding data of the specified entity:

{
  "business_profile": {
    "mcc": "1731",
    "url": "https://mycompany.com"
  },
  "tos_acceptance": {
    "ip": "192.0.2.1",
    "date": "2023-03-21T12:30:45.933Z"
  },
  "ownership_declaration": {
    "ip": "192.0.2.1",
    "date": "2023-05-03T11:27:54.736Z"
  }
}