Get role match details

GET

https://api.sureshake.com/v2/hiring/roles/{id}/match

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- candidateId
  string
  required
- roleId
  string
  required
  format: uuid
- matchScore
  number
  required
  maximum: 1 · minimum: 0
- skillMatches
  array of
  object
  required
  skillId
  string
  required
  skillName
  string
  required
  level
  required
  or
  preferred
  or
  nice_to_have
  required
  matched
  boolean
  required
  candidateYears
  optional
  number
  requiredYears
  optional
  number
  evidencePaths
  optional
  array of
  object
  pathType
  string
  required
  skillId
  optional
  string
  or null
  detail
  optional
  string
  weight
  optional
  number
  or null
  nodes
  optional
  array of
  object
  type
  string
  required
  id
  string
  or null
  required
  demonstrationConfidence
  optional
  number
  demonstrationSource
  optional
  string
  attestationTypes
  optional
  array of
  string
- explanation
  object
  required
  summary
  string
  required
  strengths
  array of
  string
  required
  gaps
  array of
  string
  required
  recommendations
  array of
  string
  required
- hasApplied
  boolean
  required
- applicationStatus
  optional
  string
- evidencePaths
  optional
  array of
  object
  pathType
  string
  required
  skillId
  optional
  string
  or null
  detail
  optional
  string
  weight
  optional
  number
  or null
  nodes
  optional
  array of
  object
  type
  string
  required
  id
  string
  or null
  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
}

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
}

Get role match details

curl --request GET \
  --url 'https://api.sureshake.com/v2/hiring/roles/<id>/match'

const url = 'https://api.sureshake.com/v2/hiring/roles/<id>/match';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": {
    "candidateId": "string",
    "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
    "matchScore": 1,
    "skillMatches": [
      {
        "skillId": "string",
        "skillName": "string",
        "level": "required",
        "matched": true,
        "candidateYears": 0,
        "requiredYears": 0,
        "evidencePaths": [
          {
            "skillId": "string",
            "pathType": "string",
            "detail": "string",
            "weight": 0,
            "nodes": [
              {}
            ]
          }
        ],
        "demonstrationConfidence": 0,
        "demonstrationSource": "string",
        "attestationTypes": [
          "string"
        ]
      }
    ],
    "explanation": {
      "summary": "string",
      "strengths": [
        "string"
      ],
      "gaps": [
        "string"
      ],
      "recommendations": [
        "string"
      ]
    },
    "hasApplied": true,
    "applicationStatus": "string",
    "evidencePaths": [
      {
        "skillId": "string",
        "pathType": "string",
        "detail": "string",
        "weight": 0,
        "nodes": [
          {
            "type": "string",
            "id": "string"
          }
        ]
      }
    ]
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}