Authorize an Integration Partner

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint authorizes an Integration Partner to gain access at the level defined by the provided Integration Permission, to the data of the provided company.

Once this endpoint has been called, Check will send a temporary authorization code to a redirect URI on the Integration Partner's server, which they will then be able to exchange for an access token that can be used to read and write data in Check's API for the provided company, according to the scopes of the Integration Permission.

This endpoint has an associated component, Authorize integration, which can be used instead.

Path Params
string
required

ID of the Integration Partner

Body Params
string
required

ID of the company whose data you want to grant the Integration Partner access to

string
required

ID of the Integration Permission you want to grant to the Integration Partner

string
required

The timestamp when the customer consented to a terms of service document consenting to sharing their data with the Integration Partner

string
required

The timestamp when the customer purchased the product offered by the Integration Partner

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json