Update

Update Client

PATCH https://biometridon.polygon.pt/api/clients/:id

This endpoint allows you to update a client by id. This route is only for Master Users.

Path Parameters

Name	Type	Description
id	string	ID of the client to get

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Authentication user token

Request Body

Name	Type	Description
key	string	Unique key
name	string	Unique name
flows	array	List of flow id
settingsId	string	Client settings id
pusher	object	Pusher information
twilio	object	Twilio information
biometrid	object	Biometrid information

200

{
  "data": {
    "key": "key1",
    "name": "client1",
    "flows": [""],
    "pusher": {
      "appId": "",
      "key": "",
      "secret": "",
      "privateChannels": true
    },
    "twilio": {
      "account": "",
      "key": "",
      "secret": "",
      "smsAccountsId": "",
      "smsAuthToken": "",
      "smsFromNumber": ""
    },
    "biometrid": {
      "key": "",
      "secret": "",
      "url": "https://api.biometrid.com/api/1.1"
    },
    "settingsId": "",
    "userId": "",
    "active": true,
    "isMaster": false,
    "created_at": "2020-07-09T16:26:23.702Z",
    "updated_at": "2020-07-09T16:26:23.702Z",
    "id": "5f07452f79f2e851bc3eb837"
  },
  "meta": {
    "message": "Client Updated with success."
  },
  "status": true
}

404

{
  "data": {},
  "meta": {
    "message": "Client not found",
    "code": "4012"
  },
  "status": false
}

Update my Client

PATCH https://biometridon.polygon.pt/api/clients

This endpoint allow you to update the user client information.

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Authentication user token

Request Body

Name	Type	Description
key	string	Unique key
name	string	Unique name
flows	array	List of flow id
settingsId	string	Client settings id
pusher	object	Pusher information
twilio	object	Twilio information
biometrid	object	Biometrid information

200

{
  "data": {
    "key": "key1",
    "name": "client1",
    "flows": [""],
    "pusher": {
      "appId": "",
      "key": "",
      "secret": "",
      "privateChannels": true
    },
    "twilio": {
      "account": "",
      "key": "",
      "secret": "",
      "smsAccountsId": "",
      "smsAuthToken": "",
      "smsFromNumber": ""
    },
    "biometrid": {
      "key": "",
      "secret": "",
      "url": "https://api.biometrid.com/api/1.1"
    },
    "settingsId": "",
    "userId": "",
    "active": true,
    "isMaster": false,
    "created_at": "2020-07-09T16:26:23.702Z",
    "updated_at": "2020-07-09T16:26:23.702Z",
    "id": "5f07452f79f2e851bc3eb837"
  },
  "meta": {
    "message": "Client Updated with success."
  },
  "status": true
}

// Example

{
	"key": "key1",
	"secret": "12345678",
	"name": "client1",
  "flows": [""],
  "settingsId": "",
	"pusher": {
		"appId": "",
		"key": "",
		"secret": "",
		"privateChannels": true
	},
	"twilio": {
		"account": "",
		"key": "",
		"secret": "",
		"smsAccountsId": "",
		"smsAuthToken": "",
		"smsFromNumber": ""
	},
	"biometrid": {
		"key": "",
		"secret": "",
		"url": "https://api.biometrid.com/api/1.1"
	},
	"liveness": {
		"url": "",
		"token": ""
	}
}