Initiating a Video Call with End User
In this API you will create the call in which the RE Agent and the customer will be connected together. It is a fully customizable flow that can be pre-configured and sent through this API.
Kindly look into the pre-configurations in the admin portal before this step and set up the required parameters and options.
To create a new video call, the following request needs to be submitted with this API.ย
In this request, you'll be required to send the customerโs data, for example, an Identity photo with details, document details & customer info, etc.
Apart from preconfiguring in the admin portal, you can also configure the entire video call of each customer flow such as
- Having customizable Questions and Answers during the video call
- Real-Time feedback form for RE agent during the call
- Real-Time face match score for the required documents with live customer
- Post-call feedback form for the RE Agent once the call is ended
More details are described below for each parameter.ย
- Create a call object
- POST the request
Create the call object, containing the following parameters:
Key | Required/Optional | Data type | Description |
userData | Required | Object | Customer details are to be shown to the RE agent before the KYC starts. |
documents | Required | Object | Document details in Sidebar to the RE agent during the call. An array of objects. |
instructions | Optional | Object | Questionnaire & real-time feedback during calls. An array of objects. |
fields | Optional | Object | Post Call feedback for RE agents. An array of objects. |
meetingName | Optional | Object | Name of the meeting. |
emailRequired | Optional | Object | To send an invite email to the customer or not when the call is created. |
callbackSystem | Optional | Object | The data callback URLs will be provided here.ย |
metaData | Optional | Object | Metadata for prioritizing the call or scheduling the call. |
To pass the customer information to the RE agent to view before the KYC start, these parameters must be passed in โuserDataโ :
Key | Required/Optional | Data type | Description |
name | Required | String | The name of the user. |
Required | String | The email of the user. | |
additinalData | Optional | Object | Any other additional fields of customer information can be passed here. |
To pass the document information to the RE agent to view in the sidebar, we need 3 things: the document's name, datasets, and an image. These documents belong to the customer and will be useful for agents to scrutinize. This object is an array that can be passed multiple times and the RE agent can view them as a dropdown in the sidebar.
Let's take an example of Passport Identity- it has multiple images, datasets(name, Date of birth, full address, etc.):
Key | Required/Optional | Data type | Description |
documentName | Optional | String | The title for the document that is being passed. For example, if the document object is about Passport Identity, then this could be named as shown in the example. |
data | Optional | Object | This object is used to pass as many parameters as possible for filling in the document details. They can be as shown in the example. |
images | Optional | String | An array of images visible as a carousel for RE agents. |
image | Optional | String | One single image is shown to the RE agent. |
useForFaceMatch | Optional | Boolean | If the image contains an image and needs to be used for face match scoring with the customer who is on camera, this can be used. |
metaData is used to specify the priority and type of the call. Properties under the parameter โmetaDataโ are:
Key | Required/Optional | Data type | Description |
priority | Optional | List | To provide the priority of the call. PRIORITY means priority or else non-priority call. |
Use the authentication token that is obtained through the Customer login API to access the following.
Supported methods: POST
Base URL for Pre Production: http://video-conf-demo.signzy.app/๏ปฟ
Base URL for production: http://video-conf.signzy.app/๏ปฟ
A successful API request generates an HTTP 200 response. The response to a request where the output format was specified as JSON, is a JSON array with a response status.
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].
๏ปฟ