{REST:API} Integration Manual

Partner Service API

Authentication Management
Revision 1.0.0

Prepared by
Bangladesh Election Commission
National Identity Registration Wing (NIDW)

All information provided in this document is strictly confidential and intended solely for the evaluation committee. Unless used exclusively
for the purpose of the project for which this document is intended, no part of this publication may be reproduced in any form, in an
electronic retrieval system or otherwise, without the prior written permission of the publisher.
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 2

Contents

Disclaimer ............................................................................................................................................... 3
General Information............................................................................................................................... 4
RESTful API Functional Overview........................................................................................................... 5
Auth Service (Login) ........................................................................................................................... 5
Auth Service (Logout) ......................................................................................................................... 5
Change Password ............................................................................................................................... 5
Technical Specification of the RESTful API ............................................................................................ 6
Base URL ............................................................................................................................................. 6
Auth Service (Login) ........................................................................................................................... 6
Sample Request .............................................................................................................................. 6
Sample Response............................................................................................................................ 6
Response Code and Messages ....................................................................................................... 7
Auth Service (Logout) ......................................................................................................................... 8
Sample Response............................................................................................................................ 8
Response Code and Messages ....................................................................................................... 8
Consequences of Password Expiration .............................................................................................. 9
Sample Response............................................................................................................................ 9
Change Password ............................................................................................................................... 9
Sample Request .............................................................................................................................. 9
Sample Response............................................................................................................................ 9
Response Code and Messages ..................................................................................................... 10
Conclusion ............................................................................................................................................ 11

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 3

Disclaimer
This document is for the internal use of and Bangladesh Election Commission only. Portions of the
documents will remain the intellectual property of Bangladesh Election Commission such details are
not to be passed to anyone. No part of this document may be reproduced, stored in a retrieval
system or transmitted in any form or by any means, electronic, mechanical, photocopying,
recording, scanning or otherwise for any purpose, without the express written permission of
Bangladesh Election Commission.

Additionally, this document contains confidential information on National ID system architecture

and thus may not be shared or disclosed to anyone. Any violation of the confidentiality of this
document may result in security breaches and pose threats to the national database.

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 4

General Information
Bangladesh Voter Registration System or BVRS is the central enterprise application solution of
Bangladesh Election Commission. It is a custom solution designed and developed specifically for
Bangladesh Election commission based on their operational requirements.

The system architecture of BVRS was very well planned and sophisticated, considering the time at
which it was designed and developed. But, with time and increased usage and demand, it was
unable to meet the new requirements. In continuation of running with different issues at BVRS,
considering the technological barriers Bangladesh Election Commission has taken steps to upgrade
the entire solution with the Up-to- date & High-tech Sophisticated Enterprise Technologies.

Partner Service Application of the CMS Module caters External Partners Requests for Voter
Information and Voter Information Verification using the API and Web Portals. Government
Agencies like Special Branch, Police & RAB, Non-Government Partners like Banks and Telco
Operators can request for Voter Specific Information or Verify Voter Information under a Service
Level Agreement (SLA) with the Bangladesh Election Commission.

This guide is intended for the developers (from authorized organizations) who plan to integrate their
system with Bangladesh Election Commission over shared RESTful API to get specific services.

Developers are able to build custom applications and services in their platform of choice that
supports the open standard RESTful “Web Services” methodology.

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 5

RESTful API Functional Overview

Auth Service (Login)

This RESTful Service Handles Authentication Process Securely using a valid Login Credentials shared
by Bangladesh Election Commission.

Auth Service (Logout)

This RESTful Service Handles Authentication Process Securely using a valid Logout request.

Change Password

This RESTful service is designed for Changing Passwords used for API authentication. The Election
Commission Partners are required to update their passwords according to three specified
parameters, ensuring password effectiveness for the following 45 days.

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 6

Technical Specification of the RESTful API

Base URL
The Base URL is: [Link]

Auth Service (Login)

API URL: [Link]
Request Type: POST
Parameter Content Type: application/json

Parameter Name Description Type

Username Provided by EC to access NID Partner
Username MANDATORY
Service
Password Provided by EC to access NID Partner
Password MANDATORY
Service

Sample Request

{
"password": "string",
"username": "string"
}

Sample Response

{
"status": "OK",
"statusCode": "SUCCESS",
"success": {
"data": {
"username": "afis_user",
"access_token":
"eyJ0eXAiOiJhY2Nlc3NfdG9rZW4iLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZmlzX3
VzZXIiLCJyb2xlcyI6WyJBRklTX1ZFUklGSUNBVElPTiJdLCJpYXQiOjE1NjY4MjQxNT
IsImV4cCI6MTU2NjgyNzc
Mn0.vrbtvUDDRyREJ0xKmK5auqc0N_6cMsEbmb221K8VbDs",
"refresh_token":
"[Link]
X3VzZXIiLCJpYXQiOjE1NjY4MjQxNTIsImV4cCI6MTU2NjgzMTM1Mn0.J6lAxUyWefXT
Smxmzivj0CGu0agxy6C1qKVzAcf2AWA"
}
}
}

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 7

Response Code and Messages

Tag: success
- Code: 200
- Message: Successful

Tag: error
- Code: 201
- Message: Created
- Code: 400
- Message: Bad Request
- Code: 401
- Message: You are not authorized to view the resource
- Code: 403
- Message: Accessing the resource you were trying to reach is forbidden
- Code: 404
- Message: The resource you were trying to reach is not found
- Code: 500
- Message: Internal Server Error

Tag: result
- If the operation was successful, this field will have the result.
1. Access token
2. Refresh token
3. Username

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 8

Auth Service (Logout)

API URL: [Link]
Request Type: POST
Parameter Content Type: application/json
Request Header: Bearer Token

Sample Response

{
"status": "OK",
"statusCode": "SUCCESS",
"success": {
"data": "Logout Successful"
}
}

Response Code and Messages

Tag: success
- Code: 200
- Message: Successful

Tag: error
- Code: 201
- Message: Created
- Code: 400
- Message: Bad Request
- Code: 401
- Message: You are not authorized to view the resource
- Code: 403
- Message: Accessing the resource you were trying to reach is forbidden
- Code: 404
- Message: The resource you were trying to reach is not found
- Code: 500
- Message: Internal Server Error

Tag: result
- If the operation was successful, this field will have the result.
1. Logout success message.

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 9

Consequences of Password Expiration

Users will receive a notification as mentioned in the 'Sample Response’ when their password expires.
This response applies to all APIs, and users must reset their password through the "Change
Password" API.

Sample Response

{
"status": "UNAUTHORIZED",
"statusCode": "ERROR",
"error": {
"field": "Authorization",
"message": "Access is denied"
}
}

Change Password
API URL: [Link]
user-password
Request Type: POST
Parameter Content Type: application/json
Request Header: Bearer Token

Parameter Name Description Type

MANDATORY
currentPassword Users current password
(less than 50 character)
MANDATORY
newPassword New password that users want to set
(less than 50 character)
MANDATORY
confirmPassword Rewrite the new password to confirm
(less than 50 character)

Sample Request

{
"currentPassword": "string",
"newPassword": "string",
"confirmPassword": "string"
}

Sample Response

{
"status": "OK",
"statusCode": "SUCCESS",
"success": {
"data": "Password Updated Successfully"
}
}

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 10

{
"status": "BAD_REQUEST",
"statusCode": "ERROR",
"error": {
"field": "password",
"message": "Old Password and New Password Cannot Be Same"
}
}

{
"status": "BAD_REQUEST",
"statusCode": "ERROR",
"error": {
"field": "confirmPassword",
"message": "Password Should Not Be Greater than 50
Character"
}
}

{
"status": "BAD_REQUEST",
"statusCode": "ERROR",
"error": {
"message": "Message not readable or request body is empty"
}
}

NOTE: Upon successful password update, the user session will terminate.

Response Code and Messages

Tag: success
- Code: 200
- Message: Successful

Tag: error
- Code: 201
- Message: Created
- Code: 401
- Message: You are not authorized to view the resource
- Code: 403
- Message: Accessing the resource you were trying to reach is forbidden
- Code: 404
- Message: The resource you were trying to reach is not found
- Code: 500
- Message: Internal Server Error

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban
BANGLADESH VOTER REGISTRATION SYSTEM (BVRS) 11

Conclusion

A group of Servers is dedicated to running the Partner Service Application of CMS Module. We are
expecting End Users will experience extraordinary performance with less downtime under the
Optimized Application Architecture.

Bangladesh Election Commission

© 2024 All rights reserved National Identity Registration Wing (NIDW), Nirbachan Bhaban