Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Pass the {format} and {language} parameters in the URI of a GET call.

Property

Type

Description

format

String

The Output Format for the response

language

String

The preferred Target language in which the domains should be returned

Sample Request

Code Block
curl -X GET -v https://cvlizer.joinvision.com/cvlizer/rest/v1/domains/json/en \
-H 'Authorization: Bearer <Product-Token>'

...

Provide the {format} parameter in the URI of a POST call and a JSON payload in the body with the following parameters:

Property

Type

Description

model

String

Extraction Model

data

String, base64 encoded

The binary data of the document to be extracted, encoded with base64

filename

String

The filename of the document.

language

String

OPTIONAL: Preferred Target Language. Default is “en”

Note

If the filename entered in parameter “filename” does not contain a postfix, the extraction will fail

...

If your request is successful, the API returns a XML object as String, following the respective XML schema based on the chosen Extraction Model. More information on the returned XML can be found in the JoinVision XML 3.0 Schema Description (the returned JSON is equivalent to the XML).

...

Pass the {format} parameter in the URI of a POST call and a JSON payload in the body with the following parameters:

Property

Type

Description

documents

inputDoc[]

An array of documents of the type InputDoc

Sample Request

Code Block
curl -X POST -v https://cvlizer.joinvision.com/cvlizer/rest/v1/categorize \
  -H 'Authorization: Bearer <Product-Token>' \
  -d '{ \
          'documents': \
          [ \
              { \
                  "filename":"cv.pdf", \
                  "data": "JVBERi0xL...", \
              }, \
              { \
                  "filename":"letter.doc", \
                  "data": "SXAolk2f8...", \
              } \
          ] \
      }

...

Provide the output {format} parameter in the URI of a POST call and a JSON payload in the body with the following parameters:

Property

Type

Description

model

String

Extraction Model

Note

Merge currently only supports model “cvlizer_3_0”

documents

InputDoc[]

An array of documents of the type InputDoc

Note

One of the files is required to be a CV

language

String

OPTIONAL: Preferred Target Language. Default is “en”

Sample Request

Code Block
curl -X POST -v https://cvlizer.joinvision.com/cvlizer/rest/v1/merge/xml \
  -H 'Authorization: Bearer <Product-Token>' \ 
  -d '{ \
        "model":"cvlizer_3_0", \
        "documents": \
	[ \
            { \
	       "filename":"cv1.pdf", \
               "data": "JVBERi0xL...", \
            }, \
            { \
	       "filename":"cv2.pdf", \
               "data": "SXAolk2f8...", \
            } \
	], \
        "language":"de" \
      }'

...

If your request is successful, the API returns a XML object as String, following the respective XML schema based on the chosen Extraction Model. More information on the returned XML can be found in the JoinVision XML 3.0 Schema Description (the returned JSON is equivalent to the XML).