Accredifi
API docs by Redocly

Accredifi Institutional API (1.0.0)

Download OpenAPI specification:

License: Accredifi License Agreement

Institution-facing HTTP API for Accredifi integrators.

Auth

Get OAuth client credentials token

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Value: "client_credentials"
client_id
required
string
client_secret
required
string
scope
string or null

Responses

Response samples

Content type
application/json
{
  • "token_type": "string",
  • "expires_in": 0,
  • "access_token": "string"
}

Institution API

List institution access requests

Authorizations:
clientCredentialsAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": { },
  • "meta": { }
}

Create institution access request

Authorizations:
clientCredentialsAuth
Request Body schema: application/json
required
type
required
string
Enum: "EMAIL" "URL_ONE_TIME"
scopes
required
Array of strings non-empty
reference
string or null <= 255 characters
email
string or null <email> <= 255 characters
verification_schedule
string or null <uuid>
verification_schedule_start
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "type": "EMAIL",
  • "scopes": [
    ],
  • "reference": "string",
  • "email": "user@example.com",
  • "verification_schedule": "69334033-7b68-4e78-8c88-96fb51d577fb",
  • "verification_schedule_start": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Show institution access request

Authorizations:
clientCredentialsAuth
path Parameters
access_request
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete institution access request

Authorizations:
clientCredentialsAuth
path Parameters
access_request
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}