CV & VACANCY PARSER
API DOCUMENTATION
Nobl Document Parser API (0.0.1)
Download OpenAPI specification:Download
The HR Software linking job and applicant without ifs, buts, or maybes.
The Nobl Document Parser API follows the principles of REST, providing a straightforward and efficient way to parse CVs and job advertisements into structured JSON data. The API has predictable resource-oriented URLs, accepts multipart form data with file uploads, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The API accepts document files (PDF, DOCX, TXT) and returns structured JSON data with extracted information including personal details, experience, skills, education for CVs, or job requirements, responsibilities, and company information for job advertisements.
The Nobl API uses API Keys to authenticate requests. A client_id and client_secret will be provided by the Nobl support team allowing for authentication at the /auth endpoint. Upon successful authentication, a time-limited Access Token will be received and can be used to authorize subsequent requests by including the header Authorization: Bearer {access_token}.
Authenticate
Authenticates a client with the Nobl Document Parser API using client_id and client_secret.
Upon successful authentication, a time-limited Access Token will be received and can be used to authorize subsequent requests by including the header Authorization: Bearer {access_token}.
Note: Contact support@nobl.ai to obtain your client credentials.
Request Body schema: application/jsonrequired
| client_id required | string (Client Id) The client ID provided by Nobl support team. |
| client_secret required | string (Client Secret) The client secret provided by Nobl support team. |
| scope | string (Scope) Default: "api/ALL" The authentication scope. |
| type | string (Type) Default: "client" Enum: "client" "user" The type of user being authenticated. |
Responses
Request samples
- Payload
{- "client_id": "string",
- "client_secret": "string",
- "scope": "api/ALL",
- "type": "client"
}Response samples
- 200
- 422
{- "access_token": "string",
- "token_type": "bearer",
- "expires_in": 0,
- "scope": "string"
}Parse Document Endpoint
Parses a CV or Job Advertisement document and extracts structured information.
Supported File Types:
- PDF (.pdf) - Portable Document Format
- Microsoft Word (.docx, .doc) - Word documents
- Text (.txt) - Plain text files
Document Types:
- cv: For parsing CVs and resumes. Extracts personal information, work experience, education, skills, etc.
- job_advertisement: For parsing job postings. Extracts job requirements, responsibilities, company information, etc.
Response:
Returns structured JSON data with extracted information specific to the document type.
Authorizations:
Request Body schema: multipart/form-datarequired
| file required | string <binary> (File) The document file to parse. Supported formats: PDF, DOCX, DOC, TXT. Maximum size: 10MB. |
| document_type required | string (Document Type) Enum: "cv" "job_advertisement" The type of document to parse. 'cv' for CV/Resume, 'job_advertisement' for Job Advertisement. |
Responses
Response samples
- 200
- 422
{- "success": true,
- "document_type": "string",
- "filename": "string",
- "file_size": 0,
- "extracted_data": { },
- "processing_time": 0,
- "timestamp": "string"
}