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.

Get the onboarding data

To get information about the onboarding data of a specific entity, call GET /v1/entities/{entity_id}/onboarding_data:

curl -X GET 'https://api.sandbox.monite.com//v1/entities/{entity_id}/onboarding_data' \
     -H 'X-Monite-Version: 2023-06-04' \
     -H 'Authorization: Bearer ACCESS_TOKEN'

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

{
  "business_profile": {
    "mcc": "1731",
    "url": "https://monite.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"
  }
}

Update the onboarding data

To update the onboarding data of a specific entity, call PUT /v1/entities/{entity_id}/onboarding_data:

curl -X PUT 'https://api.dev.monite.com/v1/entities/{entity_id}/onboarding_data' \
     -H 'X-Monite-Version: 2023-06-04' \
     -H 'Authorization: Bearer ACCESS_TOKEN'
     -H 'Content-Type: application/json' \
     -d '{
    "business_profile": {
      "mcc": "1731",
      "url": "https://monite.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"
    }
  }'

The successful response will contain the just updated onboarding data information:

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