Show
Get Step by ID
GET https://biometridon.polygon.pt/api/steps/:id
This endpoint allows you to get a step information by id.
Path Parameters
Name
Type
Description
id
string
ID of the step to get
Headers
Name
Type
Description
Authorization
string
Authentication user token
// Step idcard
{
"data": {
"label": "Dados Identificação",
"aliasId": "DADOS_IDENTIF",
"type": "idcard",
"settings": {
"fields": [
{
"type": "text",
"aliasId": "doctype",
"label": "Document type",
"editable": true,
"rules": [
{
"type": "valid",
"value": [
"passport",
"idcard"
]
},
{
"type": "required"
}
]
},
{
"type": "file",
"aliasId": "front",
"label": "Front image",
"editable": true,
"rules": [
{
"type": "typesAllowed",
"value": [
"jpg",
"jpeg",
"png"
]
},
{
"type": "required"
}
]
},
{
"type": "file",
"aliasId": "back",
"label": "Back image",
"editable": true,
"rules": [
{
"type": "typesAllowed",
"value": [
"jpg",
"jpeg",
"png"
]
},
{
"type": "dependency",
"field": "doctype",
"value": "idcard"
}
]
}
]
},
"required": false,
"clientId": "5f06dd360d2a954da80c098f",
"forAllClients": true,
"active": true,
"created_at": "2020-07-09T09:02:49.329Z",
"updated_at": "2020-07-09T09:02:49.329Z",
"id": "5f06dd39a89fd30bd4671866"
},
"meta": {
"message": "Success."
},
"status": true
}
// Step selfie
{
"data": {
"label": "Comprovativo Identidade",
"aliasId": "COMP_IDENTID",
"type": "selfie",
"settings": {
"match": false,
"liveness": false,
"fields": [
{
"type": "file",
"aliasId": "file_selfie",
"label": "Selfie image",
"editable": true,
"rules": [
{
"type": "typesAllowed",
"value": [
"jpg",
"jpeg",
"png"
]
},
{
"type": "required"
}
]
}
]
},
"required": false,
"clientId": "5f06dd360d2a954da80c098f",
"forAllClients": true,
"active": true,
"created_at": "2020-07-09T09:02:49.333Z",
"updated_at": "2020-07-09T09:02:49.333Z",
"id": "5f06dd39a89fd30bd4671867"
},
"meta": {
"message": "Success."
},
"status": true
}
// Step ocr-selfie
{
"data": {
"label": "OCR e Selfie compare",
"aliasId": "OCR_SELFIE",
"type": "ocr-selfie",
"settings": {
"match": false,
"liveness": true,
"fields": [
{
"type": "text",
"aliasId": "doctype",
"label": "Document type",
"editable": true,
"rules": [
{
"type": "valid",
"value": [
"passport",
"idcard"
]
},
{
"type": "required"
}
]
},
{
"type": "file",
"aliasId": "front",
"label": "Front image",
"editable": true,
"rules": [
{
"type": "typesAllowed",
"value": [
"jpg",
"jpeg",
"png"
]
},
{
"type": "required"
}
]
},
{
"type": "file",
"aliasId": "back",
"label": "Back image",
"editable": true,
"rules": [
{
"type": "typesAllowed",
"value": [
"jpg",
"jpeg",
"png"
]
},
{
"type": "dependency",
"field": "doctype",
"value": "idcard"
}
]
},
{
"type": "file",
"aliasId": "file_selfie",
"label": "Selfie image",
"editable": true,
"rules": [
{
"type": "typesAllowed",
"value": [
"jpg",
"jpeg",
"png"
]
},
{
"type": "required"
}
]
},
{
"type": "text",
"aliasId": "zoomSessionId",
"label": "Zoom Session Id",
"editable": true,
"rules": [
{
"type": "dependency_setting",
"field": "liveness",
"value": true
},
{
"type": "format",
"value": "string"
}
]
},
{
"type": "text",
"aliasId": "facemap",
"label": "Facemap",
"editable": true,
"rules": [
{
"type": "dependency_setting",
"field": "liveness",
"value": true
},
{
"type": "dependency",
"field": "zoomSessionData",
"value": null
},
{
"type": "format",
"value": "string"
}
]
}
]
},
"required": false,
"clientId": "5f06dd360d2a954da80c098f",
"forAllClients": true,
"active": true,
"created_at": "2020-07-09T09:02:49.340Z",
"updated_at": "2020-07-09T09:02:49.340Z",
"id": "5f06dd39a89fd30bd467186b"
},
"meta": {
"message": "Success."
},
"status": true
}
// Step OTP
{
"data": {
"label": "OTP",
"aliasId": "OTP",
"type": "otp",
"settings": {
"otp_type": "sms",
"max_attempts": 5,
"fields": [
{
"type": "text",
"aliasId": "otp_code",
"label": "OTP Code",
"editable": false,
"rules": [
{
"type": "format",
"value": "numeric"
},
{
"type": "length",
"value": 4
}
]
},
{
"type": "text",
"aliasId": "phone_number",
"label": "Number",
"editable": false,
"rules": [
{
"type": "phonenumber"
}
]
}
]
},
"required": false,
"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."
},
"status": true
}
// Step videoconference
{
"data": {
"label": "Videoconferência",
"aliasId": "VIDEO",
"type": "videoconference",
"settings": {
"schedule": true,
"otp": false,
"fields": [
{
"type": "text",
"aliasId": "postpone",
"label": "Postpone",
"editable": true,
"rules": [
{
"type": "format",
"value": "boolean"
}
]
},
{
"type": "text",
"aliasId": "otp",
"label": "otp",
"editable": true,
"rules": [
{
"type": "format",
"value": "string"
}
]
},
{
"type": "text",
"aliasId": "date",
"label": "Date",
"editable": true,
"rules": [
{
"type": "date"
},
{
"type": "dependency",
"field": "postpone",
"value": true
}
]
},
{
"type": "text",
"aliasId": "videoComplete",
"label": "Video Complete",
"editable": true,
"rules": [
{
"type": "format",
"value": "boolean"
}
]
},
{
"type": "text",
"aliasId": "videoAvailable",
"label": "video Available",
"editable": true,
"rules": [
{
"type": "format",
"value": "boolean"
}
]
},
{
"type": "text",
"aliasId": "snapshots",
"label": "Snapshots",
"editable": true,
"rules": [
{
"type": "format",
"value": "array"
}
]
}
]
},
"required": false,
"clientId": "5f06dd360d2a954da80c098f",
"forAllClients": true,
"active": true,
"created_at": "2020-07-09T09:02:49.335Z",
"updated_at": "2020-07-09T09:02:49.335Z",
"id": "5f06dd39a89fd30bd4671868"
},
"meta": {
"message": "Success."
},
"status": true
}
// Step form
{
"data": {
"label": "Dados Pessoais",
"aliasId": "DADOSPESS",
"type": "form-file",
"settings": {
"fields": [
{
"type": "text",
"aliasId": "account_type",
"label": "Dados de Conta (Seleccionar Conta)",
"editable": false,
"rules": [
{
"type": "minlength",
"value": 6
},
{
"type": "maxlength",
"value": 6
}
]
},
{
"type": "text",
"aliasId": "account_holder",
"label": "Titulares (Número de titulares)",
"editable": false,
"rules": [
{
"type": "accountholders"
}
]
},
{
"type": "select",
"aliasId": "client_account_purpose",
"label": "Finalidade da Conta (Finalidade e natureza da Relação de Negócio)",
"editable": false,
"options": [
{
"value": "P01",
"label": "FAMILIAR/PESSOAL/INDIVIDUAL"
}
],
"rules": [
{
"type": "minlength",
"value": 3
},
{
"type": "maxlength",
"value": 3
}
]
},
{
"type": "multiselect",
"aliasId": "funds_origin",
"label": "Origem dos fundos",
"editable": true,
"options": [
{
"value": "BE",
"label": "BOLSA DE ESTUDO"
},
{
"value": "HE",
"label": "HERANÇA"
},
{
"value": "PE",
"label": "PENSÃO"
},
{
"value": "RC",
"label": "RENDIMENTOS DE CAPITAL"
},
{
"value": "RE",
"label": "RENDIMENTOS DE IMÓVEIS"
},
{
"value": "SA",
"label": "SALÁRIO"
},
{
"value": "OU",
"label": "OUTROS (DESCREVER)"
}
],
"rules": [
{
"type": "valid",
"value": [
"BE",
"HE",
"PE",
"RC",
"RE",
"SA",
"OU"
]
}
]
},
{
"type": "text",
"aliasId": "other_funds_origin",
"label": "Diga qual?",
"editable": true,
"rules": [
{
"type": "dependency",
"field": "funds_origin",
"value": "OU"
}
]
},
{
"type": "file",
"aliasId": "file_doc_pre_cont",
"label": "Informação pré-contratual (Pack pré-contratual)",
"rules": [
{
"type": "typesAllowed",
"value": [
"jpg",
"jpeg",
"png",
"pdf"
]
}
]
},
{
"type": "file",
"aliasId": "file_doc_personal_data",
"label": "Condições Tratamento Dados Pessoais",
"editable": true,
"rules": [
{
"type": "typesAllowed",
"value": [
"jpg",
"jpeg",
"png",
"pdf"
]
}
]
},
{
"type": "text",
"aliasId": "accept_terms_conditions",
"label": "Li e aceito os termos",
"editable": true,
"rules": [
{
"type": "maxlength",
"value": 1
},
{
"type": "required"
}
]
},
{
"type": "text",
"aliasId": "date_of_accept_term_conditions",
"label": "Data de aceitação dos termos",
"editable": true,
"rules": [
{
"type": "maxlength",
"value": 25
},
{
"type": "required"
}
]
},
{
"type": "text",
"aliasId": "name",
"label": "Nome",
"rules": [
{
"type": "minlength",
"value": 2
},
{
"type": "maxlength",
"value": 100
},
{
"type": "required"
}
]
},
{
"type": "text",
"aliasId": "surname",
"label": "Apelido",
"rules": [
{
"type": "minlength",
"value": 2
},
{
"type": "maxlength",
"value": 100
},
{
"type": "required"
}
]
},
{
"type": "text",
"aliasId": "client_email",
"label": "(Insira) Email",
"editable": true,
"rules": [
{
"type": "email"
},
{
"type": "maxlength",
"value": 200
},
{
"type": "required"
}
]
},
{
"type": "text",
"aliasId": "client_phonenumber",
"label": "(Insira) Nº Telémovel",
"rules": [
{
"type": "maxlength",
"value": 20
},
{
"type": "required"
}
]
},
{
"type": "text",
"aliasId": "personal_data_aut1",
"label": "Autorizo a recolha e tratamento… (pergunta 1)",
"rules": [
{
"type": "maxlength",
"value": 1
}
]
},
{
"type": "text",
"aliasId": "client_nif",
"label": "(Insira) Nº Contribuinte",
"editable": true,
"rules": [
{
"type": "regex",
"value": "[0-9]{9}"
}
]
},
{
"type": "text",
"aliasId": "personal_data_aut2",
"label": "Autorizo a recolha e tratamento… (pergunta 2)",
"rules": [
{
"type": "maxlength",
"value": 1
}
]
},
{
"type": "text",
"aliasId": "telef_verif_ind",
"label": "Validação do Telémovel (SMS/OTP)",
"rules": [
{
"type": "maxlength",
"value": 1
}
]
},
{
"type": "text",
"aliasId": "date_of_phone_validation",
"label": "Data de validação telemóvel",
"rules": [
{
"type": "maxlength",
"value": 25
}
]
}
]
},
"required": false,
"clientId": "5f06dd360d2a954da80c098f",
"forAllClients": true,
"active": true,
"created_at": "2020-07-09T09:02:49.233Z",
"updated_at": "2020-07-09T09:02:49.234Z",
"id": "5f06dd39a89fd30bd4671862"
},
"meta": {
"message": "Success."
},
"status": true
}Last updated
Was this helpful?