Skip to main content
GET
/
v1
/
authentication
/
{registrationId}
Fetch Registration Status
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/authentication/{registrationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-challengecode: <x-challengecode>' \
  --header 'x-tenant-id: <x-tenant-id>'
{
  "RequestStatusInfo": {
    "AppId": "<string>",
    "RegistrationRequestId": "<string>",
    "Status": 0
  },
  "Token": {
    "ApiKey": "<string>"
  },
  "GrantedScopes": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-challengecode
string
required

You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

registrationId
string
required

Unique identifier of the registration request

Response

Registration information (containing the current status of the registration process)

Model Class: RegistrationInformation

RequestStatusInfo
object
required

Status of the registration process (including the unique identifiers for application and registration request)

Token
object

Generated token for the application to access the API

GrantedScopes
string[]

API scopes (both mandatory and optional) granted to the application