Learn

Claims Source

Configure a claims source

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.

Analytic event

  • CLAIM_SOURCE_CREATE_START
  • CLAIM_SOURCE_CREATE_SUCCESS
  • CLAIM_SOURCE_CREATE_FAIL
SecuritybearerAuth
Request
Request Body schema: application/json
required

The claim source payload

name
required
string

Claims source name.

url
required
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.

Enum: "GET" "POST"
required
Mapping only (object) or Mapping with fallback (object) or Static value (object)

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.
required
API Key (object) or OAuth Client Credentials (object)

Authentication method configuration to access the claims source.

Responses
201

Claims source configured

400

Bad Request

post/core/v1/claim-sources
Request samples
application/json
{
  • "name": "Claims source accepting a x-api-key header",
  • "url": "https://example.com/api/data",
  • "authorization": {
    },
  • "requestParameters": {
    }
}
Response samples
application/json
{
  • "name": "Claims source accepting a x-api-key header",
  • "url": "https://example.com/api/data",
  • "authorization": {
    },
  • "requestParameters": {
    }
}

Retrieve all claims sources

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

Analytic event

  • CLAIM_SOURCE_RETRIEVE_LIST_START
  • CLAIM_SOURCE_RETRIEVE_LIST_SUCCESS
  • CLAIM_SOURCE_RETRIEVE_LIST_FAIL
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]

Range size of returned entries, default 100

Example: limit=2
cursor
string

Starting point for the range of entries

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Claims sources retrieved

400

Bad Request

get/core/v1/claim-sources
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
Retrieve a claims source
Retrieves an existing claims source by providing its claimSourceID.


Analytic event


    

  • CLAIM_SOURCE_RETRIEVE_START
    • 

  • CLAIM_SOURCE_RETRIEVE_SUCCESS
    • 

  • CLAIM_SOURCE_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Claims source ID


 
 Example:  41458e5a-9092-40b7-9a26-d4eb43c5792f
Responses 
200
Claims source retrieved


400
Bad Request


404
Claims source not found


get/core/v1/claim-sources/{id}
Request samples 
Response samples 
application/json
{
  • "id": "57fa09e2-82f3-4d3d-9eca-d0253e84a4e6",
  • "name": "My claims from example.com",
  • "url": "https://example.com",
  • "requestMethod": "GET",
  • "requestParameters": {
    },
  • "authorization": {
    }
}
Update a claims source
Updates an existing claim source by providing its claimSourceID.


Analytic event


    

  • CLAIM_SOURCE_UPDATE_START
    • 

  • CLAIM_SOURCE_UPDATE_SUCCESS
    • 

  • CLAIM_SOURCE_UPDATE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Claims source ID


 
 Example:  41458e5a-9092-40b7-9a26-d4eb43c5792f
Request Body schema: application/json
required
The updated claims source payload


name
required
string
Claims source name.


 
url
required
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.


 Enum: "GET" "POST"  
required
Mapping only (object) or Mapping with fallback (object) or Static value (object)
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.
    • 



 
required
API Key (object) or OAuth Client Credentials (object)
Authentication method configuration to access the claims source.


 
Responses 
200
Claims source updated


400
Bad Request


404
Claims source not found


put/core/v1/claim-sources/{id}
Request samples 
application/json
{
  • "name": "My claims from example.com",
  • "url": "https://example.com",
  • "requestMethod": "GET",
  • "requestParameters": {
    },
  • "authorization": {
    }
}
Response samples 
application/json
{
  • "id": "57fa09e2-82f3-4d3d-9eca-d0253e84a4e6",
  • "name": "My claims from example.com",
  • "url": "https://example.com",
  • "requestMethod": "GET",
  • "requestParameters": {
    },
  • "authorization": {
    }
}
Delete a claims source
Deletes an existing claims source by providing its claimSourceID.


Analytic event


    

  • CLAIM_SOURCE_DELETE_START
    • 

  • CLAIM_SOURCE_DELETE_SUCCESS
    • 

  • CLAIM_SOURCE_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Claims source ID


 
 Example:  41458e5a-9092-40b7-9a26-d4eb43c5792f
Responses 
204
Claims source deleted


400
Bad Request


404
Claims source not found


delete/core/v1/claim-sources/{id}
Request samples 
Response samples 
application/json
{
  • "code": "BadRequest",
  • "message": "Validation Error",
  • "details": [
    ]
}
➔ Next to Compact Credential Configuration