ScreenCV. API documentation

Introduction

Welcome to the ScreenCV API!

You can use our API to extract valuable information from resume (CV) files, such as first and last name, contact information, photo etc.

In addition, we convert resume source files into HTML.

File formats: *.doc, *.docx, *.pdf, *.odt, *.txt, *.html

Authentication

YOUR_API_KEY, YOUR_SECRET_KEY must be sent with all client requests. These keys allow the server validate the request source.

Request

https://api.screencv.com/resume/parse
Authorization: Bearer YOUR_API_KEY

Parameters:

Name	Type	Description
sk	string	PHP example (YOUR_SK_ENCODE_RESULT): base64_encode(hex2bin(sha1(md5_file(var_file).md5(YOUR_SECRET_KEY))))
params	array	"skills":[ {"name":"Angular"}, {"name":"JS"}, {"name":"Java"}, {"name":"PHP"}, {"name":"MS Office"} ]
var_file	file	Resume.doc

cURL:

curl    -X POST "https://api.screencv.com/resume/parse" \
        -H "Authorization: Bearer YOUR_API_KEY" \
        -H "Content-Type: multipart/form-data" \
        -F "var_file=@Resume.doc" \
        -F "sk=YOUR_SK_ENCODE_RESULT" \
        -F "params = {
                    "skills":[
                        {"name":"Angular"},
                        {"name":"JS"},
                        {"name":"Java"}, 
                        {"name":"PHP"}, 
                        {"name":"MS Office"}
                    ]
            }"

Response

API returns response in JSON format.

{ 
    "skills":[
        {
            "name":"Java"
        },
        {
            "name":"PHP"
        },
        {
            "name":"MS Office"
        }
    ],
    "email":[ 
        "johnsmith@gmail.com"
    ],
    "socials":{ 
        "mailru":"http://my.mail.ru/mail/johnsmith/",
        "linkedin":"ua.linkedin.com/pub/john-smith/50/1b8/a21"
    },
    "webpage":[
        "good.com"
    ],
    "telephone":[
        "+1 (773) 555-12-34"
    ],
    "salary":{
        "value":"5000",
        "currency":"usd"
    },
    "birthday":{
        "day":"20",
        "month":"09",
        "year":"1988",
        "date":"1988-09-20"
    },
    "name":"John",
    "surname":"James",
    "patronymic":"Smith",
    "gender":"Male",
    "location":{
        "town":"Chicago",
        "country":"USA",
        "address":"5, Green str"
    },
    "skype":"johnsmithskype",
    "html":"<html>Some html ...<html>",
    "filename":"Resume.doc",
    "text":"Some text ..."
}

Errors

400 Bad Request
401 Unauthorized — "You are requesting with an invalid credential"
403 Forbidden — "You are not allowed to perform this action"
404 Not Found — "Page not found"