Current Step

Get Process current Step

GET https://biometrid.com/api/processes/:id/step

This endpoint allows you to get the current process step.

Path Parameters

Name	Type	Description
id	string	ID of the process to get

Headers

Name	Type	Description
Accept-Language	string	en (default), pt
Authorization	string	Authentication account token

200

{
  "data": {
    "processId": "string",
    "step": {
      "isProcessing": false,
      "id": "string",
      "name": "string",
      "description": "string",
      "actions": [
        {
          "type": "string",
          "fields": [
            {
              "type": "string",
              "alias": "string",
              "label": "string",
              "options": [
                {
                  "value": "string",
                  "label": "string"
                },
              ],
              "rules": [
                {
                  "type": "string"
                },
              ]
            },
          ],
          "settings": {}
        }
      ],
      "settings": {
        "wait": true
      }
    }
  },
  "meta": {
    "message": "Success."
  },
  "status": true
}

404

{
  "data": {},
  "meta": {
    "message": "Process not found",
    "code": "BIOPRGB001"
  },
  "status": false
}