Create onboarding

API for creating new onboarding requests, this API creates Onboarding Model

API Interface

Creating a new onboarding object

POST /api/partners/onboarding/v1

This API creates new onboarding request based on the fields below.

Headers

Name	Type	Description
Authorization*	String	Auth token from auth/token API

Request Body

Name	Type	Description
name*	string	The business name of the merchant that will be created
house_number*	number	The house number of the merchant that will be created
street*	string	The street of the merchant that will be created
title*	string	The display name of the merchant that will be created
phone*	string	The phonse number of the merchant that will be created
country*	string	The countrty of the merchant that will be created
city*	string	The city of the merchant that will be created
logo	string	The logo of the merchant that will be created
website	string	The website of the merchant that will be created
owner.first_name*	string	The first name of the merchant's owner
owner.last_name*	string	The last name of the merchant's owner
email*	string	The email address of the merchant that will be created
locale	string	The locale of the merchant that will be created, can be one of the following: IL, Russia, Canada, USA
state	string	The state of the merchant that will be created
category*	string	The business category of the merchant that will be created
owner.phone*	string	The phone number of the merchant's owner
owner.email*	string	The email address of the merchant's owner
owner.locale	string	The locale of the merchant's owner, can be one of the following: IL, Russia, Canada, USA, USD - PST
locations*	array of objects	An array of the merchant's locations (stores) example: [{ "name": "store1" }]
locations.name*	String	The name of the merchant's location (store)
EIN*	string	The Employer Identification Number of the merchant that will be created
locations.number	String	The number of the merchant's location (store), the default, if no value is provided, is 1
locations.logo	String	The logo of the merchant's location (store)
owner*	object

200: OK OK

See Onboarding entity schema: # onboarding-entity

{
    "uid": "52c8e55d-26dc-4935-9214-e3fccf6c8bcf",
    "url": "https://partner.sandbox.sensepass.com/partnersOnBoarding/52c8e55d-26dc-4935-9214-e3fccf6c8bcf",
    "status": "Pending"
}

400: Bad Request Invalid Input

{
    "statusCode": 400,
    "message": [
        "category should not be empty"
    ],
    "error": "Bad Request"
}

500: Internal Server Error Internal Error

{
    // Response
}

Examples

Basic request example to create a new onboarding process.

{
	"name": "ski and snowboard inc",
	"title": "ski&snowboard",
	"category": "ski",
	"country": "Italy",
	"city": "abrotzo",
	"street": "very goood thing",
	"house_number": "100",
	"EIN": "89485721",
	"phone": "19148759682",
	"email": "[e-mail]",
	"state": "my state",
	"owner": {
		"first_name": "moshe",
        	"last_name": "israel",
		"phone": "1555888999",
		"email": "[e-mail]"
	},
	"locations": [{
		"name": "my store"
	}]
}

Schema

Full Onboarding Entity schema: #onboarding-entity