Get CV
recruitment/get-cv@1.0.014 providers
Get CV
Get a candidate's CV document, by candidate ID. Returns either a URL, or binary data of the CV document, depending on the provider.
Input
Contact ID
Result
Curriculum Vitae
Rate limit
1.Choose a provider
2.Use GetCV with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Copied!
const { SuperfaceClient } = require('@superfaceai/one-sdk');
// You can manage tokens here: https://superface.ai/insights
const sdk = new SuperfaceClient({ sdkAuthToken: '<< Login to get your token >>' });
async function run() {
// Load the profile
const profile = await sdk.getProfile('recruitment/get-cv@1.0.0');
// Use the profile
const result = await profile
.getUseCase('GetCV')
.perform({
candidateId: 'CANDIATE_ID'
}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Input (object)
candidateId
required
Unique identifier of the candidate. Use the `recruitment/list-candidates` profile to get candidate IDs.
string
Example
{
"candidateId": "CANDIATE_ID"
}Copied!
Result (object)
cv
optional
The CV of the candidate.
object
createdAt
optional
ISO8601 timestamp of when the CV was uploaded.
string
document
optional
Binary content and file name of the CV document.
object
fileName
optional
The file name of the CV document.
string
content
optional
The content of the CV document.
documentUrl
optional
The URL of the CV document.
string
rateLimit
optional
Rate limit details.
object
bucket
optional
Different parts of the API may have different rate limits.
Bucket identifies which part of API the rate limits apply to.
string
totalRequests
optional
Total requests available in the time window.
number
remainingRequests
optional
Remaining requests available in the time window.
number
remainingRequestsPercentage
optional
Remaining requests available in the time window in percents.
number
resetTimestamp
optional
Timestamp when the rate limits will reset (in Unix Timestamp format). Available only for providers without rolling rate limit window.
number
Example
{
"cv": {
"createdAt": "2023-01-05T10:04:58.325Z",
"document": {
"fileName": "cv.pdf",
"content": "<BinaryData>"
}
}
}Copied!