Skip to main content

Authenticate your entity

VIDcredentials authentication service. Get your accessToken here. Remember that the access token is a JWT with an expiration time so from time to time you will need to get a new one.

Request Body REQUIRED
grantType string REQUIRED

OAuth 2.0 grant type. Must be set to "urn:ietf:params:oauth:grant-type:jwt-bearer"

assertion string REQUIRED

JSON encoded in base64. Decode provided example to see the values within.

scope string REQUIRED

Scope is used to define the authentication method.

expiresIn number

Time in seconds after which the token should not be accepted

Responses
200

Success

Schema
accessToken string

A signed JWT Access Token issued by the vidchain-api to access the API.

tokenType string

Type of the authentication token. Supported type "bearer".

expiresIn integer

JWT expiration in seconds.

issuedAt string

Time of JWT issuance. Format: unix timestamp

400

Bad Request

Schema
type uri

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: 400 ≤ value < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

500

Internal Server Error

Schema
type uri

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: 400 ≤ value < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.