potential-match-response.json

{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "https://github.internet2.edu/benno/id-match-api/tree/draft/schema/json/potential-match-response.json",
  "title": "TAP Identity Match Potential Match Found Response",
  "description": "Potential match(es) found for search request",
  "type": "object",
  "properties": {
    "candidates": {
      "description": "An array of candidates",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "confidence": {
            "description": "Optional but strongly recommended confidence indicator intended to help the administrator resolving the potential match; 100 is reserved for canonical searches that return multiple matches",
            "type": "integer",
            "minimum": 1,
            "maximum": 100
          },
          "referenceId": {
            "description": "Match Reference Identifier, or the string 'new' to indicate the original request as a new record",
            "type": "string"
          },
          "explanation": {
            "description": "A human readable explanation as to why this candidate was returned, to provide guidance to an administrator reviewing the request",
            "type": "string"
          },
          "attributes": {
            "description": "An array of SoR records for this candidate",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "record": {
                  "description": "The attributes for this candidate as asserted by the System of Record",
                  "$ref": "https://github.internet2.edu/benno/core-schema/tree/draft/schema/json/core-schema.json#/properties/mixed"
                }
              }
            }
          },
          "golden": {
            "description": "The golden record for this candidate (for coordinated implementations); if present, attributes may be empty",
            "type": "object",
            "properties": {
              "record": {
                "description": "The attributes for this candidate as asserted by the System of Record",
                "$ref": "https://github.internet2.edu/benno/core-schema/tree/draft/schema/json/core-schema.json#/properties/mixed"
              }
            }
          },
          "identifiers": {
            "$ref": "https://github.internet2.edu/benno/core-schema/tree/draft/schema/json/attribute-dictionary.json#/definitions/identifiers",
            "minItems": 1,
            "uniqueItems": true
          },
        },
        "required": [ "referenceId", "attributes" ]
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "matchRequest": {
      "description": "Match Request Identifier identifying this transaction",
      "type": "string"
    }
  },
  "required": [ "candidates" ]
}