API Reference

Configure a Claims source

POST/v1/claim-sources

Configures a new claims source for your tenant. When issuing a new credential, MATTR VII will make either a GET or a POST request to the claims source using the configured request parameters and fetch available data. This fetched data can then be included in the issued credential.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_CREATE_STARTCLAIM_SOURCE_CREATE_SUCCESSCLAIM_SOURCE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The claim source payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/claim-sources" \  -H "Content-Type: application/json" \  -d '{    "name": "Claims source accepting a x-api-key header",    "url": "https://example.com/api/data",    "authorization": {      "type": "api-key",      "value": "6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J"    },    "requestParameters": {      "account_type": {        "mapFrom": "claims.accountType",        "defaultValue": "account.student"      },      "account_id": {        "mapFrom": "claims.accountId"      }    }  }'

{  "name": "Claims source accepting a x-api-key header",  "url": "https://example.com/api/data",  "authorization": {    "type": "api-key",    "value": "****************************************61m1J"  },  "requestParameters": {    "account_type": {      "mapFrom": "claims.accountType",      "defaultValue": "account.student"    },    "account_id": {      "mapFrom": "claims.accountId"    }  }}

Retrieve all Claim sources

GET/v1/claim-sources

Returns a list of all claims sources configured on your tenant.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_RETRIEVE_LIST_STARTCLAIM_SOURCE_RETRIEVE_LIST_SUCCESSCLAIM_SOURCE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned entries, default 100

Range1 <= value <= 1000

cursor?string

Starting point for the range of entries

Response Body

`application/json`

curl -X GET "https://example.com/v1/claim-sources"

{  "nextCursor": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "url": "string",      "requestMethod": "GET",      "requestParameters": {        "mapFrom": "string"      },      "authorization": {        "type": "api-key",        "value": "string"      }    }  ]}

Retrieve a Claim source

GET/v1/claim-sources/{id}

Retrieves an existing claims source by providing its claimSourceID.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_RETRIEVE_STARTCLAIM_SOURCE_RETRIEVE_SUCCESSCLAIM_SOURCE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Claims source ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/claim-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "url": "string",  "requestMethod": "GET",  "requestParameters": {    "mapFrom": "string"  },  "authorization": {    "type": "api-key",    "value": "string"  }}

Update a Claim source

PUT/v1/claim-sources/{id}

Updates an existing claim source by providing its claimSourceID.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_UPDATE_STARTCLAIM_SOURCE_UPDATE_SUCCESSCLAIM_SOURCE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Claims source ID

Formatuuid

Request Body

application/json

The updated claims source payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/claim-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "url": "string",    "requestParameters": {      "mapFrom": "string"    },    "authorization": {      "type": "api-key"    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "url": "string",  "requestMethod": "GET",  "requestParameters": {    "mapFrom": "string"  },  "authorization": {    "type": "api-key",    "value": "string"  }}

Delete a Claim source

DELETE/v1/claim-sources/{id}

Deletes an existing claims source by providing its claimSourceID.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_DELETE_STARTCLAIM_SOURCE_DELETE_SUCCESSCLAIM_SOURCE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Claims source ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/claim-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Configure a Claims source

POST/v1/claim-sources

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_CREATE_STARTCLAIM_SOURCE_CREATE_SUCCESSCLAIM_SOURCE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The claim source payload

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Claims source name.

url*string

Claims source URL (and any redirects it may include):

Must be a valid URL.
Must use the HTTPS protocol.
Must not be an IP address.
Must not include query parameters.
Unicode will be converted to ASCII.

requestMethod?string

Indicates the request method MATTR VII will use when retrieving data from this claims source. Both the GET and POST method are supported. If no value is provided, GET is used by default. When using POST, all requestParameters must be included in the request body in JSON format.

Value in

"GET"
"POST"

requestParameters*||

Use this object to define how to map request parameters that are sent to your claims source using the mapFrom and defaultValue properties:

When only providing mapFrom, the request parameter will be mapped from the defined path. If mapping fails, no alternative value is used. You can map data from both the claims and credentialConfiguration objects.
When providing both mapFrom and defaultValue, MATTR VII will attempt to map the request parameter from the defined path. If mapping fails, the defaultValue is used instead.
When only providing defaultValue, its value is used to populate the request parameter, regardless of any available claims values.

authorization*|

Authentication method configuration to access the claims source.

Response Body

`application/json`

curl -X POST "https://example.com/v1/claim-sources" \  -H "Content-Type: application/json" \  -d '{    "name": "Claims source accepting a x-api-key header",    "url": "https://example.com/api/data",    "authorization": {      "type": "api-key",      "value": "6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J"    },    "requestParameters": {      "account_type": {        "mapFrom": "claims.accountType",        "defaultValue": "account.student"      },      "account_id": {        "mapFrom": "claims.accountId"      }    }  }'

{  "name": "Claims source accepting a x-api-key header",  "url": "https://example.com/api/data",  "authorization": {    "type": "api-key",    "value": "****************************************61m1J"  },  "requestParameters": {    "account_type": {      "mapFrom": "claims.accountType",      "defaultValue": "account.student"    },    "account_id": {      "mapFrom": "claims.accountId"    }  }}

Retrieve all Claim sources

GET/v1/claim-sources

Returns a list of all claims sources configured on your tenant.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_RETRIEVE_LIST_STARTCLAIM_SOURCE_RETRIEVE_LIST_SUCCESSCLAIM_SOURCE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned entries, default 100

Range1 <= value <= 1000

cursor?string

Starting point for the range of entries

Response Body

`application/json`

curl -X GET "https://example.com/v1/claim-sources"

{  "nextCursor": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "url": "string",      "requestMethod": "GET",      "requestParameters": {        "mapFrom": "string"      },      "authorization": {        "type": "api-key",        "value": "string"      }    }  ]}

Retrieve a Claim source

GET/v1/claim-sources/{id}

Retrieves an existing claims source by providing its claimSourceID.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_RETRIEVE_STARTCLAIM_SOURCE_RETRIEVE_SUCCESSCLAIM_SOURCE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Claims source ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/claim-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "url": "string",  "requestMethod": "GET",  "requestParameters": {    "mapFrom": "string"  },  "authorization": {    "type": "api-key",    "value": "string"  }}

Update a Claim source

PUT/v1/claim-sources/{id}

Updates an existing claim source by providing its claimSourceID.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_UPDATE_STARTCLAIM_SOURCE_UPDATE_SUCCESSCLAIM_SOURCE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Claims source ID

Formatuuid

Request Body

application/json

The updated claims source payload

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Claims source name.

url*string

Claims source URL (and any redirects it may include):

Must be a valid URL.
Must use the HTTPS protocol.
Must not be an IP address.
Must not include query parameters.
Unicode will be converted to ASCII.

requestMethod?string

Value in

"GET"
"POST"

requestParameters*||

Use this object to define how to map request parameters that are sent to your claims source using the mapFrom and defaultValue properties:

When only providing mapFrom, the request parameter will be mapped from the defined path. If mapping fails, no alternative value is used. You can map data from both the claims and credentialConfiguration objects.
When providing both mapFrom and defaultValue, MATTR VII will attempt to map the request parameter from the defined path. If mapping fails, the defaultValue is used instead.
When only providing defaultValue, its value is used to populate the request parameter, regardless of any available claims values.

authorization*|

Authentication method configuration to access the claims source.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/claim-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "url": "string",    "requestParameters": {      "mapFrom": "string"    },    "authorization": {      "type": "api-key"    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "url": "string",  "requestMethod": "GET",  "requestParameters": {    "mapFrom": "string"  },  "authorization": {    "type": "api-key",    "value": "string"  }}

Delete a Claim source

DELETE/v1/claim-sources/{id}

Deletes an existing claims source by providing its claimSourceID.

Roles

adminissuermanaged-issuer

Analytics Events

CLAIM_SOURCE_DELETE_STARTCLAIM_SOURCE_DELETE_SUCCESSCLAIM_SOURCE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Claims source ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/claim-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Roles

Analytics Events

201application/json

400application/json

Example Authorization with x-api-key header

Example Authorization with OAuth 2.0 client credentials

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

API Reference

Roles

Analytics Events

201application/json

400application/json

Example Authorization with x-api-key header

Example Authorization with OAuth 2.0 client credentials

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`