List
List Processes
GET https://biometridon.polygon.pt/api/processes
This endpoint allows you to get all existing processes.
Query Parameters
Name
Type
Description
clientId
string
Client id (Master User) (default authentication client user)
search
string
Search for all columns
id
string
Find by id
status
string
Find by status (multiple values splitted by comma)
remainingSteps
string
Find by remaining steps
created_at
string
format: start,end
deleted_at
string
Find by deleted_at date
columns
string
Find by log information
sortBy
string
Pagination column order (default created_at)
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
{
"data": [
{
"_id": "5efe1546d677cb49cc08a9dc",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [
"5e3814fffc9ced14a824d6fa"
],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
}
],
"status": "rejected",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [],
"notes": [
{
"text": "fdfhgh",
"created_at": "2020-07-02T17:11:48.050Z"
}
],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T17:11:42.954Z"
},
{
"action": "process-reject",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"data": {
"text": "fdfhgh",
"created_at": "2020-07-02T17:11:48.050Z"
},
"created_at": "2020-07-02T17:11:48.053Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T17:11:34.748Z",
"created_at": "2020-07-02T17:11:34.748Z",
"updated_at": "2020-07-02T17:11:48.054Z",
"deleted_at": "2020-07-02T17:11:48.050Z"
},
{
"_id": "5efe14ead677cb49cc08a9bd",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [
"5e3814fffc9ced14a824d6fa"
],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
}
],
"status": "rejected",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [],
"notes": [
{
"text": "sdfsdfsdf",
"created_at": "2020-07-02T17:13:11.925Z"
}
],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T17:10:20.418Z"
},
{
"action": "process-reject",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"data": {
"text": "sdfsdfsdf",
"created_at": "2020-07-02T17:13:11.925Z"
},
"created_at": "2020-07-02T17:13:11.934Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T17:10:02.590Z",
"created_at": "2020-07-02T17:10:02.590Z",
"updated_at": "2020-07-02T17:13:11.937Z",
"deleted_at": "2020-07-02T17:13:11.925Z"
},
{
"_id": "5efe1483d677cb49cc08a987",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
},
{
"step": "5e3814fffc9ced14a824d6fa",
"data": {
"videoComplete": true,
"snapshots": [],
"videoAvailable": true
}
}
],
"status": "finished",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [
"5efe14c9d677cb49cc08a9a6",
"5efe14c9d677cb49cc08a9a8"
],
"notes": [],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T17:08:29.081Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T17:08:19.193Z",
"created_at": "2020-07-02T17:08:19.194Z",
"updated_at": "2020-07-02T17:09:29.705Z"
},
{
"_id": "5efe13c974dbca4594bfb249",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
},
{
"step": "5e3814fffc9ced14a824d6fa",
"data": {
"videoComplete": true,
"snapshots": [],
"videoAvailable": true
}
}
],
"status": "finished",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [
"5efe13ef74dbca4594bfb268",
"5efe13ef74dbca4594bfb26a"
],
"notes": [],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T17:05:21.319Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T17:05:13.352Z",
"created_at": "2020-07-02T17:05:13.354Z",
"updated_at": "2020-07-02T17:05:51.192Z"
},
{
"_id": "5efe12eab32e8a2e289ce82c",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
},
{
"step": "5e3814fffc9ced14a824d6fa",
"data": {
"videoComplete": true,
"snapshots": []
}
}
],
"status": "finished",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [
"5efe1306b32e8a2e289ce850"
],
"notes": [],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T17:01:40.605Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T17:01:30.304Z",
"created_at": "2020-07-02T17:01:30.306Z",
"updated_at": "2020-07-02T17:01:58.413Z"
},
{
"_id": "5efe1298bc92434894a0736f",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
},
{
"step": "5e3814fffc9ced14a824d6fa",
"data": {
"videoComplete": true,
"snapshots": [],
"videoAvailable": true
}
}
],
"status": "rejected",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [
"5efe12b7bc92434894a07393",
"5efe12b7bc92434894a07395"
],
"notes": [
{
"text": "fdfdf",
"created_at": "2020-07-02T17:01:38.341Z"
}
],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T17:00:16.079Z"
},
{
"action": "process-reject",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"data": {
"text": "fdfdf",
"created_at": "2020-07-02T17:01:38.341Z"
},
"created_at": "2020-07-02T17:01:38.345Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T17:00:08.715Z",
"created_at": "2020-07-02T17:00:08.716Z",
"updated_at": "2020-07-02T17:01:38.346Z",
"deleted_at": "2020-07-02T17:01:38.341Z"
},
{
"_id": "5efe12307628973d98cda485",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
},
{
"step": "5e3814fffc9ced14a824d6fa",
"data": {
"videoComplete": true,
"snapshots": []
}
}
],
"status": "finished",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [
"5efe12547628973d98cda4aa"
],
"notes": [],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T16:58:36.754Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T16:58:24.857Z",
"created_at": "2020-07-02T16:58:24.859Z",
"updated_at": "2020-07-02T16:59:00.179Z"
},
{
"_id": "5efe0e75e1f2475684660129",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
},
{
"step": "5e3814fffc9ced14a824d6fa",
"data": {
"videoComplete": true,
"snapshots": []
}
}
],
"status": "rejected",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [
"5efe0e93e1f2475684660149"
],
"notes": [
{
"text": "sdfgnjhgfhfg",
"created_at": "2020-07-02T16:58:34.169Z"
}
],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T16:42:37.367Z"
},
{
"action": "process-reject",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"data": {
"text": "sdfgnjhgfhfg",
"created_at": "2020-07-02T16:58:34.169Z"
},
"created_at": "2020-07-02T16:58:34.177Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T16:42:29.993Z",
"created_at": "2020-07-02T16:42:29.995Z",
"updated_at": "2020-07-02T16:58:34.179Z",
"deleted_at": "2020-07-02T16:58:34.169Z"
},
{
"_id": "5efe0b4f7fe08a177ce81ae3",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
},
{
"step": "5e3814fffc9ced14a824d6fa",
"data": {
"videoComplete": true,
"snapshots": [],
"videoAvailable": true
}
}
],
"status": "finished",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [
"5efe0bc37fe08a177ce81b00",
"5efe0bc37fe08a177ce81b02"
],
"notes": [],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T16:29:12.644Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T16:29:03.679Z",
"created_at": "2020-07-02T16:29:03.680Z",
"updated_at": "2020-07-02T16:30:59.284Z"
},
{
"_id": "5efe0ab23ec33308345d762e",
"clientId": "5e3814ebba18aa24a05d42c6",
"flowId": "5e67a69bc16a117ec8a431e5",
"remainingSteps": [],
"stepData": [
{
"step": "5e3814fffc9ced14a824d6f6",
"data": {
"account_type": "123456",
"account_holder": "1",
"client_account_purpose": "P01",
"funds_origin": "OU",
"other_funds_origin": "1",
"accept_terms_conditions": "1",
"date_of_accept_term_conditions": "01/01/2019",
"name": "ruben",
"surname": "rocha",
"client_email": "ruben.rocha@polygon.pt",
"client_phonenumber": "913354444",
"personal_data_aut1": "1",
"client_nif": "123456789",
"personal_data_aut2": "1",
"telef_verif_ind": "1",
"date_of_phone_validation": "01/01/2019"
}
},
{
"step": "5e3814fffc9ced14a824d6fa",
"data": {
"videoComplete": true,
"snapshots": [],
"videoAvailable": true
}
}
],
"status": "finished",
"deviceType": "other",
"settings": {
"guide": [
{
"text": "Contrary to popular belief, Lorem Ipsum is not simply random text"
},
{
"text": "The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested."
},
{
"text": "What is Lorem Ipsum?"
},
{
"text": "1914 translation by H. Rackham"
}
],
"processUsername": [
"stepData.data.name",
"stepData.data.surname"
]
},
"videos": [
"5efe0ad43ec33308345d764d",
"5efe0ad43ec33308345d764f"
],
"notes": [],
"log": [
{
"action": "process-locked",
"entityType": "agent",
"entityId": "5e3814ebba18aa24a05d42c9",
"created_at": "2020-07-02T16:26:35.683Z"
}
],
"corrections": [],
"delete_at": "2020-07-04T16:26:26.870Z",
"created_at": "2020-07-02T16:26:26.870Z",
"updated_at": "2020-07-02T16:27:00.496Z"
}
],
"meta": {
"message": "Success.",
"pagination": {
"total": 57,
"limit": 10,
"page": 1,
"lastPage": 6,
"sortBy": "id",
"order": "asc"
}
},
"status": true
}List rejected Processes
GET https://biometridon.polygon.pt/api/processes/rejected
This endpoint allows you to get all rejected processes.
Headers
Name
Type
Description
Authorization
string
Authentication user token
{
"data": {
"total": 0,
"page": 1,
"perPage": 10,
"lastPage": 0,
"data": []
},
"meta": {
"message": "Success."
},
"status": true
} List finished Processes
GET https://biometridon.polygon.pt/api/processes/finished
This endpoint allows you to get all finished processes.
Headers
Name
Type
Description
Authorization
string
Authentication user token
{
"data": {
"total": 0,
"page": 1,
"perPage": 10,
"lastPage": 0,
"data": []
},
"meta": {
"message": "Success."
},
"status": true
}List completed Processes
GET https://biometridon.polygon.pt/api/processes/completed
This endpoint allows you to get all completed processes.
Headers
Name
Type
Description
Authorization
string
Authentication user token
{
"data": {
"total": 0,
"page": 1,
"perPage": 10,
"lastPage": 0,
"data": []
},
"meta": {
"message": "Success."
},
"status": true
}List incomplete Processes
GET https://biometridon.polygon.pt/api/processes/incomplete
This endpoint allows you to get all incompleted processes.
Headers
Name
Type
Description
Authorization
string
Authentication user token
{
"data": {
"total": 0,
"page": 1,
"perPage": 10,
"lastPage": 0,
"data": []
},
"meta": {
"message": "Success."
},
"status": true
}Last updated
Was this helpful?