Preview score impact

POST

https://api.sureshake.com/v2/entities/{entityId}/scores/preview-impact

Path parameters

entityId
string
required
format: uuid

Request body JSON

hypotheticalReportMintedAt
optional
string
format: date-time
hypotheticalVouch
optional
object
- voucherEntityId
  string
  required
  format: uuid
- confidence
  optional
  integer
  maximum: 5 · minimum: 1 · default: 3
- scope
  optional
  string
  maxLength: 64 · minLength: 1 · default: "general"
- expiresAt
  optional
  string
  or null
  format: date-time
}

Returns

200

Default Response

JSON

data
object
required
- current
  object
  required
  overall
  number
  required
  grade
  AAA
  or
  AA
  or
  A
  or
  BBB
  or
  BB
  or
  B
  +4 more
  required
  components
  object
  required
  completeness
  number
  required
  verification
  number
  required
  dataQuality
  number
  required
  networkTrust
  number
  required
  reports
  number
  required
- projected
  object
  required
  overall
  number
  required
  grade
  AAA
  or
  AA
  or
  A
  or
  BBB
  or
  BB
  or
  B
  +4 more
  required
  components
  object
  required
  completeness
  number
  required
  verification
  number
  required
  dataQuality
  number
  required
  networkTrust
  number
  required
  reports
  number
  required
- delta
  object
  required
  overall
  number
  required
  components
  object
  required
  completeness
  number
  required
  verification
  number
  required
  dataQuality
  number
  required
  networkTrust
  number
  required
  reports
  number
  required
- assumptions
  array of
  string
  required
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

501

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

curl --request POST \ --url 'https://api.sureshake.com/v2/entities/<entityId>/scores/preview-impact' \ --header 'Content-Type: application/json' \ --data ' { "hypotheticalReportMintedAt": "2019-08-24T14:15:22Z", "hypotheticalVouch": { "voucherEntityId": "687a822d-209a-4607-9d86-54cce0292c95", "confidence": 3, "scope": "general", "expiresAt": "2019-08-24T14:15:22Z" } } '

{ "data": { "current": { "overall": 0, "grade": "AAA", "components": { "completeness": 0, "verification": 0, "dataQuality": 0, "networkTrust": 0, "reports": 0 } }, "projected": { "overall": 0, "grade": "AAA", "components": { "completeness": 0, "verification": 0, "dataQuality": 0, "networkTrust": 0, "reports": 0 } }, "delta": { "overall": 0, "components": { "completeness": 0, "verification": 0, "dataQuality": 0, "networkTrust": 0, "reports": 0 } }, "assumptions": [ "string" ] }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }