Guides
Start typing to search…

Onboarding

Vendor onboarding involves several sequential API calls to register and verify a vendor account for a specific connector

For vendor onboarding, please follow the steps below:

First step - Get vendor invitation data - api reference

Retrieve vendor invitation details using the provided JWT token from the invitation link:

GET https://api.dev.mrkter.io/vendor/onboardings/current

Request must have authorization header with Bearer JWT token from invitation later link

Example response:

{
  "id": 1,
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Dow",
  "businessName": "",
  "businessRegisteredLocation": "",
  "phoneNumber": "+972501112233",
  "isPhoneNumberVerified": true,
  "phoneNumberCountry": "IL",
  "phoneNumberCode": "972",
  "finishedAt": "2023-03-31T12:57:53.089Z",
  "location": "US",
  "status": "ACTIVE",
  "timeZone": "America/New_York",
  "createdAt": "2023-03-31T12:57:53.089Z",
  "updatedAt": "2023-03-31T12:57:53.089Z",
  "isEmailVerified": true,
  "clientCompanyName": "My Company Name"
}

Second step - Save vendor data - API Referense

Submit or update vendor registration information using the /vendor/onboardings/current endpoint:

PATCH https://api.dev.mrkter.io/vendor/onboardings/current

Request must have authorization header with Bearer JWT token from invitation later link

Example request:

{
  "firstName": "Test",
  "lastName": "Auth",
  "businessName": "Test Auth LTD",
  "timeZone": "Asia/Jerusalem",
  "businessRegisteredLocation": "IL",
  "phoneNumber": "+972531112233",
  "phoneNumberCode": "+972",
  "notVerifiedPhoneNumber": "+972531112233",
  "phoneNumberCountry": "IL",
  "password": "Password1!",
  "email": "[email protected]",
  "currentPhoneCode": "+972",
  "accountType": "VENDOR"
}

Example response:

{
    "id": 918,
    "email": "[email protected]",
    "firstName": "Test",
    "lastName": "Auth",
    "businessName": "Test Auth LTD",
    "businessRegisteredLocation": "IL",
    "phoneNumber": "+972531112233",
    "phoneNumberCode": "+972",
    "phoneNumberCountry": "IL",
    "isPhoneNumberVerified": false,
    "finishedAt": null,
    "createdAt": "2025-04-10T07:01:17.512Z",
    "updatedAt": "2025-04-10T07:02:25.288Z",
    "isEmailVerified": false,
    "status": "ACTIVE",
    "timeZone": "Asia/Jerusalem",
    "location": null,
    "clientCompanyName": "Payouts Client Dev Account"
}

Third step - Get authentication token (Auth0) - api reference

Obtain an access token from Auth0 by sending user credentials to the /oauth/token endpoint:

POST https://login.dev.mrkter.io/oauth/token

Example request payload as Form Data:

grant_type: password
username: YOUR_USER_NAME
password: YOUR_PASSWORD
audience: https://dev-mrkter.io
client_id: IuNTe8fftpw3a0KJKxsxBET8t3C6agZi
connection: Username-Password-Authentication
scope: offline_access

Example response:

{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImlkTGt5YjFvaEpOSUE1M29NblYtZiJ9.eyJodHRwOi8vdHlwZSI6InVzZXIiLCJodHRwOi8vZW1haWwiOiJkbWl0cnkudit2ZW5kb3JAbXJrdGVyLmlvIiwiaHR0cDovL2p0aSI6ImI4NDE1NGYyYTU3NjJjZmI2NmJkMDYzNWVkNDM3ZDFkIiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5kZXYubXJrdGVyLmlvLyIsInN1YiI6ImF1dGgwfDY1ZTk5M2M3MjllNDBlZjFjZWJmMjMwMyIsImF1ZCI6Imh0dHBzOi8vZGV2LW1ya3Rlci5pbyIsImlhdCI6MTc0MzUwNzU0MiwiZXhwIjoxNzQzNTkwMzQyLCJzY29wZSI6Im9mZmxpbmVfYWNjZXNzIiwiZ3R5IjoicGFzc3dvcmQiLCJhenAiOiJJdU5UZThmZnRwdzNhMEtKS3hzeEJFVDh0M0M2YWdaaSJ9.poOsDK89sRJ-m1et6sM3EJgrfsgWcVRCVjl5lHwk5MO6nSLv-1KUkX5L-nG9SeFdyXWkXAyKX8s5uKSawKaPpD04rrN8Y9qSDc2USGwDb3NRhmPoY5J7wR0eqstjQlHJcq4eczxTiprNCEtYyiqgCFNPpcMB_XYQJSPbY9mQrQEf9VFoJvkr1shyvLGo-8dfN1NFJywKq6jgSH-w9AAyb8Ex2qAj4ICufPWffyAF6NoFGD5naRLe4K6_21B-nr9EMQ08c65353D0QaH2CIUDnr0HdY8bj558a9WXslqwvw4b0owMN9Pcm8E9yQckQI7uNyuE3vNvri50YYk9c7AkHA",
    "refresh_token": "v1.MfXFqd6B7GKv7Lk0sQCnwqf5RvoSvPyKDS6bz0fT15wVrFlq6rYK2BIupO1t6H0_7dlpMErFOtFzjf2vEFh1jSo",
    "scope": "offline_access",
    "expires_in": 82800,
    "token_type": "Bearer"
}

Fourth step - Send vendor phone validation SMS - API Referense

Trigger an SMS containing a verification code to the vendor’s phone number

POST https://api.dev.mrkter.io/verification/sms

Required "Authorization" header - it's access_token from previous step

Example request payload:

{
  "phoneNumber": "+972507471111"
}

Step five – validate the vendor's phone number - api reference

Confirm the phone number by submitting the received SMS verification code.

POST https://api.dev.mrkter.io/vendor/onboardings/current/phone-number/verify

Required "Authorization" header

Example request:

{
  "phoneNumber": "+9720507477980",
  "code": "194582"
}

Example response:

{
  "id": 1,
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Dow",
  "businessName": "",
  "businessRegisteredLocation": "",
  "phoneNumber": "+972501112233",
  "isPhoneNumberVerified": true,
  "phoneNumberCountry": "IL",
  "phoneNumberCode": "972",
  "finishedAt": "2023-03-31T12:57:53.089Z",
  "location": "US",
  "status": "ACTIVE",
  "timeZone": "America/New_York",
  "createdAt": "2023-03-31T12:57:53.089Z",
  "updatedAt": "2023-03-31T12:57:53.089Z",
  "isEmailVerified": true,
  "clientCompanyName": "My Company Name"
}

Step six – Send a validation email - API Referense

Send an email containing a verification code to the vendor’s email address.

POST https://api.dev.mrkter.io/verification/email

Required "Authorization" header

Example request payload:

{
  "email": "[email protected]"
}

Step seven – validate the code received via email - api reference

Verify the email by submitting the validation code received via email.

POST https://api.dev.mrkter.io/vendor/onboardings/current/phone-number/verify

Required "Authorization" header

Example request:

{
  "phoneNumber": "+9720507477980",
  "code": "194582"
}

Example response:

{
  "id": 1,
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Dow",
  "businessName": "",
  "businessRegisteredLocation": "",
  "phoneNumber": "+972501112233",
  "isPhoneNumberVerified": true,
  "phoneNumberCountry": "IL",
  "phoneNumberCode": "972",
  "finishedAt": "2023-03-31T12:57:53.089Z",
  "location": "US",
  "status": "ACTIVE",
  "timeZone": "America/New_York",
  "createdAt": "2023-03-31T12:57:53.089Z",
  "updatedAt": "2023-03-31T12:57:53.089Z",
  "isEmailVerified": true,
  "clientCompanyName": "My Company Name"
}

Step eight – Mark onboarding as complete - api reference

Finalize the onboarding process by marking the vendor’s account as completed.

POST https://api.dev.mrkter.io/vendor/onboardings/current/finish

Required "Authorization" header

Example response:

{
  "id": 1,
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Dow",
  "businessName": "",
  "businessRegisteredLocation": "",
  "phoneNumber": "+972501112233",
  "isPhoneNumberVerified": true,
  "phoneNumberCountry": "IL",
  "phoneNumberCode": "972",
  "finishedAt": "2023-03-31T12:57:53.089Z",
  "location": "US",
  "status": "ACTIVE",
  "timeZone": "America/New_York",
  "createdAt": "2023-03-31T12:57:53.089Z",
  "updatedAt": "2023-03-31T12:57:53.089Z",
  "isEmailVerified": true,
  "clientCompanyName": "My Company Name"
}

Updated about 1 month ago