VIDEO KYC
API DOCUMENT
Date: 24/11/2021
1. CASE INITIATION
This API is POST API used to Initiate new case
End user is required to prepare HTTP request with specified header and body parameters.
A. Input Parameters
Below are the input parameters of the API:-
Authorization Token should be passed in headers as:
Authorization : Token db2e4815a3ce162302a2b749e5d90eefa2ddda7f
NOTE: Authorization Token is a unique token generated after login by client superuser.
Body Parameters:
For Case Type “Video KYC”
[
{
"name": "xxxxxxxxx",
"agent": 4,
"client": 1,
"process": 1,
"case_type": "video_kyc",
"office_address": "xxxxxx",
"connection_detail": [
{
"name":"xxxxxxxx",
"email": "xyz@aaaaa.com",
"mobile_number": 1111111111
}
]
}
]
For Case Type “Personal Discussion”
[
{
"name": "xxxxxxxxx",
"agent": 4,
"client": 1,
"process": 1,
"case_type": "personal_discussion",
"office_address": "xxxxxx",
"connection_detail": [
{
"name":"xxxxxxxx",
"email": "xyz@aaaaa.com",
"mobile_number": 1111111111
},
{
"name":"yyyyyyy",
"email": "abc@aaaaa.com",
"mobile_number": 1111111111
}
]
}
]
For Case Type “Bulk Case Creation”
[
{
"name": "xxxxxxxxx",
"agent": 4,
"client": 1,
"process": 1,
"case_type": "video_kyc",
"office_address": "xxxxxx",
"connection_detail": [
{
"name":"xxxxxxxx",
"email": "xyz@aaaaa.com",
"mobile_number": 111111111
}
]
},
{
"name": "zzzzzzzzz",
"agent": 5,
"client": 1,
"process": 1,
"case_type": "video_kyc",
"office_address": "xxxxxx",
"connection_detail": [
{
"name":"xxxxxxxx",
"email": "xyz@abc.com",
"mobile_number": 111111111
}
]
}
]
Mandatory/O Comments
Parameter ptional
name Mandatory Name for the new case
agent Mandatory Agent assigned to the case
client Mandatory Client ID
process Mandatory Type of process for the video
KYC
case_type Mandatory Type of the case: video kyc or video personal discussion
connection Mandatory Details of the customer: name, email, mobile_number (all are
_detail mandatory)
is_live Optional Whether the case is live or not
office_addr Optional office address of the customer
ess
B. API Request
Endpoint URL
https://demo-qa.authbridge.com/api/case/cases/
valid Authorization Token must be passed in header
Authorization : Token db2e4815a3ce162302a2b749e5d90eefa2ddda7f
Content-Type: application/json
This is a POST request
Post Data - raw/json
C. Outputs
Below are the output scenarios of the API:-
Scenario 1: Output For Successful execution of API
Output:-
[]
status: 201 created
Scenario 2: if any other
error Output:-
status : 400 Bad Request
2. RETRIEVE CASE(S)
This API is used to fetch case information.
API is a GET API and the end user is required to prepare HTTP request with specified headers.
A. Input Parameters
After login, an agent, auditor, agent cum auditor is able to see his/her assigned cases.
Below are the input parameters of the API:-
1. Authorization Token should be passed in headers as:
Authorization : Token db2e4815a3ce162302a2b749e5d90eefa2ddda7f
NOTE:
1. Here, the Authorization Token is a unique token generated after login by an agent, auditor
or agent cum auditor.
2. After login, an agent, auditor, agent cum auditor is able to see his/her assigned cases.
2. Case ID should be passed as headers
eg:
If the end user wants to fetch details of Case ID :17
https://demo-qa.authbridge.com/api/case/cases/17
B. API Request
Endpoint URL
https://demo-qa.authbridge.com/api/case/cases/<int:case_id>/
valid Authorization Token must be passed in header
Authorization : Token db2e4815a3ce162302a2b749e5d90eefa2ddda7f
Content-Type: application/json
This is a GET request
C. Outputs
Below are the output scenarios of the API:-
Scenario 1: Output For Successful execution of API
{
"id": 17,
"process_details": {
"id": 1,
"documents": [
{
"id": xx,
"name_display": "PAN Card",
"name": "xxxx",
"key": null,
"is_agent_uploaded": false,
"created_at": "2021-08-11T20:15:54.125505+05:30",
"updated_at": "2021-08-11T20:15:54.125543+05:30",
"document_upload_event": "before_call",
"process": 1
},
{
"id": xx,
"name_display": "Aadhar Card",
"name": "xxxxxxxx",
"key": null,
"is_agent_uploaded": false,
"created_at": "2021-08-11T20:15:54.132583+05:30",
"updated_at": "2021-08-11T20:15:54.132613+05:30",
"document_upload_event": "before_call",
"process": 1
},
{
"id": xx,
"name_display": "Identity Document 1",
"name": "xxxxx",
"key": "xxxx",
"is_agent_uploaded": false,
"created_at": "2021-08-25T15:05:00.224233+05:30",
"updated_at": "2021-08-25T15:05:00.224271+05:30",
"document_upload_event": "on_call",
"process": 1
},
{
"id": xx,
"name_display": "Identity Document 2",
"name": "xxxxx",
"key": "ixxx",
"is_agent_uploaded": false,
"created_at": "2021-08-25T15:05:00.224233+05:30",
"updated_at": "2021-08-25T15:05:00.224271+05:30",
"document_upload_event": "on_call",
"process": 1
},
{
"id": xx,
"name_display": "PAN Screenshot",
"name": "xxx",
"key": "xxx",
"is_agent_uploaded": true,
"created_at": "2021-07-26T13:25:04.137555+05:30",
"updated_at": "2021-07-26T13:25:04.137633+05:30",
"document_upload_event": "before_call",
"process": 1
}
],
"name": "xxxx",
"created_at": "2021-08-11T20:15:53.750324+05:30",
"updated_at": "2021-08-17T12:15:04.085788+05:30",
"client": 1
},
"session": [],
"case_history": [],
"connections": [
{
"id": 17,
"platform_connection_details": null,
"name": "tushar0",
"connection": "e6462eea-xxxx-47db-8a2f-xxxxxxxxx",
"email": "xyz@abce.com",
"country_code": 91,
"mobile_number": 11111111111,
"is_active": true,
"face_match": null,
"aadhaar_face_match_score": null,
"pan_face_match_score": null,
"latitude": null,
"longitude": null,
"location": null,
"in_india": null,
"created_at": "2021-08-20T15:56:38.937450+05:30",
"updated_at": "2021-08-20T15:56:38.937511+05:30",
"parent_connection_id": null,
"participant_tag": null,
"ip_address": "",
"device_type": "",
"consent_datetime": null,
"geo_coordinates_capture_time": null,
"shield_response": null,
"geo_data_response": null,
"case": 17
}
],
"agent_name": "xxxxxx",
"case_tag": "New Assignation",
"reassigned_by_name": null,
"audited_by_name": null,
"transfer_by_name": null,
"name": "xxxx",
"case_type": "video_kyc",
"status": "assigned",
"is_active": true,
"assigned_at": "2021-08-20T15:56:38.890596+05:30",
"created_at": "2021-08-20T15:56:38.891474+05:30",
"updated_at": "2021-08-20T15:56:38.891507+05:30",
"completed_at": null,
"audited_at": null,
"session_scheduled_time": null,
"platform_type": "openvidu",
"is_live": false,
"start_polling": false,
"reschedule_attempt": 0,
"office_address": "",
"case_attempts_by_agent": 0,
"case_attempts_by_auditor": 0,
"admin_comment": "testing case",
"cancellation_requested_at": null,
"cancellation_reason": null,
"scheduled_by_name": null,
"rescheduled_by_name": null,
"reschedule_date": null,
"reassigned_at": null,
"agent": xx,
"client": 1,
"completed_by": null,
"audited_by": null,
"transfer_by": null,
"cancellation_requested_by": null,
"reassigned_by": null
}
}
status: 200 OK
Scenario 2: Output if any other error:
{
"detail": "Not found."
status: 404 Not Found
