Download OpenAPI specification:Download
This is Notabene API service.
This API is documented in OpenAPI format and is still in heavy development. Please contact Notabene Team before using this.
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
Customer Token information
vaspDID required | string (DID) ^did:[a-zA-Z0-9]*:.*$ |
customerRef required | string |
{- "vaspDID": "did:methd:identifier",
- "customerRef": "string"
}
{- "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"
}
User Info update information
did required | string (DID) ^did:[a-zA-Z0-9]*:.*$ |
required | Array of objects (IdentityFields) List of fields |
{- "did": "did:methd:identifier",
- "fields": [
- {
- "fieldName": "string",
- "values": [
- {
- "value": "string",
- "issuer": "did:methd:identifier",
- "issuanceDate": "2019-08-24",
- "expirationDate": "2019-08-24"
}
]
}
]
}
{- "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"
}
New user information"
email required | string <email> |
vasp required | string (DID) ^did:[a-zA-Z0-9]*:.*$ |
callback | string <uri> |
callbackExtra | string |
{- "email": "user@example.com",
- "vasp": "did:methd:identifier",
- "callbackExtra": "string"
}
Remove user data
userDID required | string (DID) ^did:[a-zA-Z0-9]*:.*$ |
vasp required | string (DID) ^did:[a-zA-Z0-9]*:.*$ |
{- "userDID": "did:methd:identifier",
- "vasp": "did:methd:identifier"
}