List

Get Steps

GET https://biometridon.polygon.pt/api/steps

This endpoint allows you to get all existing steps.

Query Parameters

Name	Type	Description
search	string	Search field for label and type columns
sortBy	string	Pagination column order (default label)
order	string	Pagination order (default asc)
page	string	Page number (default 1)
limit	string	Pagination limit (default 10)

Headers

Name	Type	Description
Authorization	string	Authentication user token

200

{
  "data": [
    {
      "label": "Comprovativo Identidade",
      "description": "Tire uma selfie",
      "aliasId": "COMP_IDENTID",
      "type": "selfie",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.333Z",
      "updated_at": "2020-07-09T09:02:49.333Z",
      "id": "5f06dd39a89fd30bd4671867"
    },
    {
      "label": "Comprovativos",
      "description": "Adicione os seus comprovativos",
      "aliasId": "COMPROVATIVOS",
      "type": "multi-file",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.336Z",
      "updated_at": "2020-07-09T09:02:49.336Z",
      "id": "5f06dd39a89fd30bd4671869"
    },
    {
      "label": "Dados Adicionais",
      "description": "Modifique os seus dados adicionais",
      "aliasId": "DADOS_ADIC",
      "type": "form",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.284Z",
      "updated_at": "2020-07-09T09:02:49.284Z",
      "id": "5f06dd39a89fd30bd4671865"
    },
    {
      "label": "Dados Domicilio",
      "description": "Modifique os seus dados de domicílio",
      "aliasId": "DADOS_DOMIC",
      "type": "form",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.247Z",
      "updated_at": "2020-07-09T09:02:49.247Z",
      "id": "5f06dd39a89fd30bd4671863"
    },
    {
      "label": "Dados Identificação",
      "description": "Adicione o seu documento de identificação",
      "aliasId": "DADOS_IDENTIF",
      "type": "document",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.329Z",
      "updated_at": "2020-07-09T09:02:49.329Z",
      "id": "5f06dd39a89fd30bd4671866"
    },
    {
      "label": "Dados Pessoais",
      "description": "Modifique os seus dados pessoais",
      "aliasId": "DADOSPESS",
      "type": "form-file",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.233Z",
      "updated_at": "2020-07-09T09:02:49.234Z",
      "id": "5f06dd39a89fd30bd4671862"
    },
    {
      "label": "Dados Profissionais",
      "description": "Modifique os seus dados profissionais",
      "aliasId": "DADOS_PROF",
      "type": "form",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.270Z",
      "updated_at": "2020-07-09T09:02:49.270Z",
      "id": "5f06dd39a89fd30bd4671864"
    },
    {
      "label": "Documento Contrato",
      "description": "Adicione o seu contrato",
      "aliasId": "DOCS_CONTRATO",
      "type": "multi-file",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.338Z",
      "updated_at": "2020-07-09T09:02:49.338Z",
      "id": "5f06dd39a89fd30bd467186a"
    },
    {
      "label": "OCR e Selfie compare",
      "description": "Adicione o seu documento de identificação e selfie",
      "aliasId": "OCR_SELFIE",
      "type": "ocr-selfie",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.340Z",
      "updated_at": "2020-07-09T09:02:49.340Z",
      "id": "5f06dd39a89fd30bd467186b"
    },
    {
      "label": "OTP",
      "description": "Verifique o One Time Password",
      "aliasId": "OTP",
      "type": "otp",
      "settings": {},
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:49.342Z",
      "updated_at": "2020-07-09T09:02:49.342Z",
      "id": "5f06dd39a89fd30bd467186c"
    }
  ],
  "meta": {
    "message": "Success.",
    "pagination": {
      "total": 12,
      "limit": 10,
      "page": 1,
      "lastPage": 2,
      "sortBy": "id",
      "order": "asc"
    }
  },
  "status": true
}

401

{
  "data": {},
  "meta": {
    "message": "Invalid JWT signature",
    "code": "E_INVALID_JWT_TOKEN"
  },
  "status": false
}