Documentation Powered by ReDoc

ZIPE (Zenoo Image Processing Engine) public API documentation (alpha)

Download OpenAPI specification:Download

License: PRIVATE

Welcome to ZIPE public API documenation

Authentication

API key

Use api-key in headers to authorization for any request.

Security scheme type: API Key
Header parameter name: api-key

Manage ZIPE request

Create ZIPE request

path Parameters
clientName
required
string
Example: "best-company"

Client account name

flowName
required
string
Example: "id-card"

ZIPE flow name

Responses

201

ZIPE request id

500

unexpected error

post /{clientName}/{flowName}
https://docverify.co/api/v1/{clientName}/{flowName}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "ok",
  • "request":
    {
    }
}

Get ZIPE request state

path Parameters
clientName
required
string
Example: "best-company"

Client account name

flowName
required
string
Example: "id-card"

ZIPE flow name

requestToken
required
string
Example: "2r8fyrmuz47rd7l3bml28udxsa"

ZIPE request token

Responses

200

ZIPE request state

404

entity not found

500

unexpected error

get /{clientName}/{flowName}/{requestToken}/state
https://docverify.co/api/v1/{clientName}/{flowName}/{requestToken}/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "ok",
  • "state":
    {
    }
}

Get ZIPE request result

path Parameters
clientName
required
string
Example: "best-company"

Client account name

flowName
required
string
Example: "id-card"

ZIPE flow name

requestToken
required
string
Example: "2r8fyrmuz47rd7l3bml28udxsa"

ZIPE request token

Responses

200

ZIPE request result

404

entity not found

500

unexpected error

get /{clientName}/{flowName}/{requestToken}/result
https://docverify.co/api/v1/{clientName}/{flowName}/{requestToken}/result

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "ok",
  • "result":
    {
    }
}

Manage fields and files

Upload file

path Parameters
clientName
required
string
Example: "best-company"

Client account name

flowName
required
string
Example: "id-card"

ZIPE flow name

requestToken
required
string
Example: "2r8fyrmuz47rd7l3bml28udxsa"

ZIPE request token

fileKey
required
string
Example: "input-file"

File key - field key of field of types image or file

Request Body schema: multipart/form-data
file
string <binary>

File content

Responses

201

file uploaded successfully

400

file wasn't uploaded

404

entity not found

500

unexpected error

post /{clientName}/{flowName}/{requestToken}/files/{fileKey}
https://docverify.co/api/v1/{clientName}/{flowName}/{requestToken}/files/{fileKey}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "ok"
}

Get output file

path Parameters
clientName
required
string
Example: "best-company"

Client account name

flowName
required
string
Example: "id-card"

ZIPE flow name

requestToken
required
string
Example: "2r8fyrmuz47rd7l3bml28udxsa"

ZIPE request token

fileKey
required
string
Example: "input-file"

File key - field key of field of types image or file

Responses

200

output image

404

entity not found

500

unexpected error

get /{clientName}/{flowName}/{requestToken}/files/{fileKey}
https://docverify.co/api/v1/{clientName}/{flowName}/{requestToken}/files/{fileKey}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "error",
  • "error":
    {
    }
}