Skip to main content
GET
/
authorize
OAuth 2 Authorization Endpoint
curl --request GET \
  --url https://developer.api.receiptor.ai/v1/authorize \
  --header 'Authorization: Bearer <token>'
{
  "code": "<string>",
  "redirect_uri": "<string>"
}

Authorizations

​
Authorization
string
header
required

This API uses OAuth 2 with the implicit grant flow. More info

Query Parameters

​
client_id
string
required

Your client ID.

​
client_secret
string
required

Your client secret.

​
state
string
required

An unguessable random string used to protect against cross-site request forgery attacks.

​
scope
enum<string>[]
required

Scope

Available options:
all,
read_time_capsules,
write_time_capsules,
read_documents,
write_documents
​
redirect_uri
string
required

A URI to which users will be redirected after authorising your app.

​
response_type
enum<string>
default:code
required

Must be set to code.

Available options:
code
​
code_challenge
string
required

Code Challenge

​
code_challenge_method
enum<string>
default:S256
required

Code Challenge Method

Available options:
S256

Response

200 - application/json

Success

​
code
string
required

A temporary authorization code which will be exchanged for an access token in the next step.

​
redirect_uri
string
required

The same string you provided as state when sending the user to Receiptor AI. If this value differs from what you sent, you must abort the authentication process.