Users

In this step, a list of users associated with a main process must be sent

Update step users

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

This endpoint allows you to update a process step users. In this step, we send a list of users. For each user, we send a notification (email/phone) and create a process associated with the main process. After all the child processes are finished, the main process will automatically change to the next step or finished (if doesn't have anymore steps). If one of the child process has been rejected, the main process will be rejected too. All child processes are created with a pre-defined flow, configurable in Backoffice. The event url and message template can be configured in Backoffice.

Path Parameters

Name
Type
Description

id

string

ID of the process to get

Headers

Name
Type
Description

Accept-Language

string

en (default), pt

Content-Type

string

application/json or multipart/form-data

Authorization

string

Authentication account token

Request Body

Name
Type
Description

users

array

List of users of the process

users.*.name

string

user name

users.*.email

string

user valid email (required if phone doesn't exists)

users.*.phone

string

user valid phone (required if email doesn't exists)

{
  "data": {
    "pending": true,
    "users": [
      {
  			"name": "string",
  			"email": "email"
  		},{
  			"name": "string",
  			"phone": "+35191......."
  		}
    ]
  },
  "meta": {
    "message": "Process awaits completion of dependent processes."
  },
  "status": true
}
// JSON Example

{
	"users": [
		{
			"name": "string",
			"email": "user1@polygon.pt"
		},{
			"name": "string",
			"phone": "+35191......."
		}
	]
}

Last updated

Was this helpful?