Get Status

Retrieve the Real-Time Authentication Status

API Endpoint

GET

https://api.ovcode.com/authentication-status/get/status?reference={val}

Request Headers

Ocp-Apim-Subscription-Key
Your Enterprise Subscription Key
Api-Key
Your Enterprise Project API Key

Request Parameter

Description
reference	Unique Reference Response from the Authentication API Response.

API Response

Success

{
    "success": "<true or false>",
    "data": {
        "error_message": null,
        "is_email": "<true or false>",
        "created_time": "<Datetime Created>",
        "updated_time": "<Datetime Updated>",
        "is_encrypted": "<true or false>",
        "blockchain_network": "<BLOCKCHAIN NETWORK>",
        "is_signed": "<true or false>",
        "reference": "<Reference>",
        "pipeline": "<Pipeline>",
        "token_id": "<TOKEN ID>",
        "project_id":"<ID>",
        "error_type": "<ERROR_TYPE>",
        "mimetype":  "<File mime-type>",
        "state":  "<Current Status>",
        "encrypted_file": "<Encrypted URI>",
        "business_id": "<ID>",
        "hash": "<SHA-256>",
        "cid": "<IPFS CID (Content Identifier)>",
        "has_password": "<true or false>",
    },
    "error": null
}

Error

{
    "success": false,
    "data": null,
    "error": "<Error Message>"
}

HTTP Status Codes

Code	Description
200	OK
201	Created
204	No Content
400	Bad Request
401	Unauthorized
404	Not Found
415	Unsupported Media Type
500	Internal Server Error