Notabene API (1.0.0)

Download OpenAPI specification:Download

API Support: tech@notabene.id URL: https://doc.notabene.id

This is Notabene API service.

Introduction

This API is documented in OpenAPI format and is still in heavy development. Please contact Notabene Team before using this.

GraphQL

We also provide the same functionality over GraphQL.

The GraphQL server is at /graphql endpoint on any server. The graphql schema can be downloaded here

Authentication

oAuth2Password

OAuth Resource Owner Password Flow

Security Scheme Type	OAuth2
password OAuth Flow	Token URL: /oauth/token Scopes: `admin` - Grand Admin access

oAuth2PasswordOptional

OAuth Resource Owner Password Flow (for optional auth)

Security Scheme Type	OAuth2
password OAuth Flow	Token URL: /oauth/token Scopes: `admin` - Grand Admin access

authentication

Authentication endpoints

Sends a magic link to the user

Request Body schema: application/json

Authentication data

email required	string <email>
callback	string <uri>
callbackExtra	string

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"callback": "http://example.com",
"callbackExtra": "string"
}

Get API token from challengeToken

query Parameters

challengeToken

required

string

ChallengeToken

Responses

Gets authenticated user info

Authorizations:

oAuth2Password

Responses

Response samples

200

Content type

application/json

{"did": "did:methd:identifier",
"fields": [{"fieldName": "string",
"values": [{"value": "string",
"issuer": "did:methd:identifier",
"issuanceDate": "2019-08-24",
"expirationDate": "2019-08-24"
}
]
}
],
"vasps": "did:methd:identifier"
}

Update User Info

Authorizations:

oAuth2Password

Request Body schema: application/json

User Info update information

did required	string (DID) ^did:[a-zA-Z0-9]:.$
required	Array of objects (IdentityFields) List of fields

Responses

Request samples

Payload

Content type

application/json

{"did": "did:methd:identifier",
"fields": [{"fieldName": "string",
"values": [{"value": "string",
"issuer": "did:methd:identifier",
"issuanceDate": "2019-08-24",
"expirationDate": "2019-08-24"
}
]
}
]
}

Response samples

200

Content type

application/json

{"did": "did:methd:identifier",
"fields": [{"fieldName": "string",
"values": [{"value": "string",
"issuer": "did:methd:identifier",
"issuanceDate": "2019-08-24",
"expirationDate": "2019-08-24"
}
]
}
],
"vasps": "did:methd:identifier"
}

Add a user email to a VASP

Authorizations:

oAuth2Password

Request Body schema: application/json

New user information"

email required	string <email>
vasp required	string (DID) ^did:[a-zA-Z0-9]:.$
callback	string <uri>
callbackExtra	string

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"vasp": "did:methd:identifier",
"callback": "http://example.com",
"callbackExtra": "string"
}

Remove a user from a VASP

Authorizations:

oAuth2Password

Request Body schema: application/json

Remove user data

userDID required	string (DID) ^did:[a-zA-Z0-9]:.$
vasp required	string (DID) ^did:[a-zA-Z0-9]:.$

Responses

Request samples

Payload

Content type

application/json

{"userDID": "did:methd:identifier",
"vasp": "did:methd:identifier"
}

Get VASP admins user info

Authorizations:

oAuth2Password

path Parameters

vaspDID

string (DID) ^did:[a-zA-Z0-9]*:.*$

Example: did:methd:identifier

VASP DID

Responses

health

Server Health

Responses

Response samples

200

Content type

application/json

{"serverDate": "2019-08-24"
}

TrustFramework

Get a list of VASPs

query Parameters

q	string string to query
page	integer page number
per_page	integer records per page
order	string^([a-z]:[ASC\|DESC]);*$ field to order by

Responses

Response samples

200

Content type

application/json

{"vasps": [{"did": "did:methd:identifier",
"fields": [{