Logo sunbit

Please enter the password to view.

Get Practice Status

GET https://api-sandbox.sunbit.com/onboarding/api/v1/location/{location}

Headers

Property Required Type Description
sunbit-key yes text Provided to you by Sunbit
sunbit-secret yes text Provided to you by Sunbit

Body

Path Parameters

Property Required Type Description
location yes text Unique identifier of the merchant.

Response

Attribute Type Description
location text Same as in request path
url text Merchant application URL for onboarding form
creationDate text Format YYYY-MM-DD
status text The list of possible statuses includes

  • CREATED
  • LOCATION_DETAILS_ADDED
  • CONTACT_DETAILS_ADDED
  • BANK_INFORMATION_ADDED
  • SUBMITTED
  • LEGAL_INFORMATION_ADDED
  • ACTIVATED
  • DECLINED
expiredInDays number Number of days for token to expire
expirationDate text Token expiration date in format YYYY-MM-DD

Example

Request

curl 'https://api-sandbox.sunbit.com/onboarding/api/v1/location/los-angeles-medical-office' \ -H 'sunbit-key: YOUR_KEY' \ -H 'sunbit-secret: YOUR_SECRET'

Response
{
"location" : "los-angeles-medical-office",
"url" : "https://merchant-onboarding.sunbit.com/hwerityQas",
"creationDate" : "2024-03-13",
"status" : "CREATED"
}

Errors

Error Code Message Description
401 Unauthorized sunbit-key and/or sunbit-secret do not match any alliance credentials
404 Resource Not Found Location was not found
422 State Not Supported Location is operating in an unsupported State
500 Internal Server Error Something went wrong on Sunbit’s side