Skip to main content

Get Schema Response

This api returns the expected schema from the derived data provider to the lender

Request Body

Response by Derived Data Provider to Lender containing the requested Schema

metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

response object REQUIRED

Status of response. Whether success or has encountered error

status string REQUIRED

Possible values: [SUCCESS, ERROR]

responseDetail string
availableSchemas object[] REQUIRED
schemaId string REQUIRED

The schema object defining the data schema and identifier schema

identifiers object[] REQUIRED
identifier string REQUIRED
identifierType string REQUIRED
Responses
200

Acknowledgement of Response Received

Schema OPTIONAL
ack object
error string
traceId string
timestamp string
400

Invalid request

404

Not found