Registration Processor APIs

This section details the service APIs in the Registration-Processor modules

1. Packet receiver API
2. Registration status API
3. Sync Registration API
4. Manual Adjudication APIs
5. Bio Dedupe API
6. Packet Generator API
7. Packet Uploader API
8. Request Handler API
9. Registration Transaction API
10. UIN Card API
11. Lost UIN Or RID API
12. Update UIN API

1 Packet Receiver API

This API receives a registration packet from the reg-client. Before moving the packet to the landing zone virus scan, the packet's trustworthiness is validated using hash value and size.

POST /registrationprocessor/v1/packetreceiver/registrationpackets

Resource URL

https://{base_url}/registrationprocessor/v1/packetreceiver/registrationpackets

Resource details

Resource Details	Description
Request format	MULTIPART
Response format	JSON
Requires Authentication	Yes

Request Path Parameters

Name	Required	Description	Comment
MultipartFile	Yes	The encrypted zip file

Request

Response

Response Header

Response-Signature = <the response signature>

Success response

Status Code: 200

Description: Packet is in PACKET_RECEIVED status

Failure response

Status Code: 200

Description: The request received is a duplicate request to upload a Packet

Failure details

Error Code	Error Message	Error Description
RPR-PKR-005	Duplicate Request Received	Duplicate Packet
RPR-PKR-006	Packet Not Available in Request	Packet missing
RPR-PKR-003	Invalid Packet Format	Format doesnot match configuration
RPR-PKR-002	Invalid Packet Size	Size more then configured
RPR-RGS-001	Unable to Access Registration Table	Database error
RPR-SYS-005	Timeout Error	Timeout Error
RPR-SYS-001	Unexpected exception	Unexpected exception
RPR-PKR-004	Packet Validation Failed	Packet Validation Failed
RPR-AUT-01	Invalid Token Present	Invalid Token Present
RPR-AUT-02	Access Denied	Access Denied
RPR-DBE-001	Data integrity violation exception	Data integrity violation exception
RPR-PKR-001	Packet Not Found in Sync Table	Packet Not Found in Sync Table
RPR-PKR-007	Unknown Exception Found	Unknown Exception Found
RPR-PKR-013	Packet Size is Not Matching	Packet Size is Not Matching
RPR-PKR-010	Virus was Found in Packet	Virus was Found in Packet
RPR-PKR-008	Virus Scan Service is Not Responding	Virus Scan Service is Not Responding
RPR-PKR-009	Packet HashSequence did not match	Packet HashSequence did not match

2 Registration Status API

This API return the registration current status for list of registration ids.

POST /registrationprocessor/v1/registrationstatus/search

Resource URL

https://{base_url}/registrationprocessor/v1/registrationstatus/search

Resource details

Resource Details	Description
Request format	JSON
Response format	JSON
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
registrationIds	Yes	List of registration ids

Request

Response

Scenario: Record Found

Status Code: 200

Description: Successfully retrieved information

Scenario: Record not found

Status Code: 200

Description: Successfully retrieved information

Failure details

Error Code	Error Message	Error Description
RPR-AUT-002	Access Denied	Access Denied for the role
RPR-RGS-001	Unable to Access Registration Table	Unable to Access Registration Table
RPR-RGS-016	JSON Mapping Failed	JSON Mapping Failed
RPR-RGS-017	JSON Parsing Failed	JSON Parsing Failed
RPR-SYS-002	Bad Gateway	Bad Gateway
RPR-DBE-001	Data integrity violation exception	Data integrity violation exception
RPR-AUT-01	Invalid Token Present	Invalid Token Present
RPR-RGS-015	Invalid Request Value - Input Data is Incorrect	Invalid Request Value - Input Data is Incorrect
RPR-RGS-031	RID Not Found	RID Not Found

3 Sync registration API

The registration ids has to be synced with server before uploading packet to landing zone. This API is used to sync registration ids.

POST /registrationprocessor/v1/registrationstatus/sync

Resource URL

https://{base_url}/registrationprocessor/v1/registrationstatus/sync

Resource details

Resource Details	Description
Request format	JSON
Response format	JSON
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
id	Yes	the id for sync	mosip.registration.sync
version	Yes	the version for sync	1.0
requesttime	Yes	the requesttime for sync	2019-02-14T12:40:59.768Z
request	Yes	the request object	1.0
registrationId	Yes	the registration id	80006444440002520181208094000
registrationType	Yes	the type of the registration	NEW, UPDATE, LOST, ACTIVATE, DEACTIVATE, RES_UPDATE
packetHashValue	Yes	the hash value of the encrypted packet	D7C87DC5D3A759D77433B02B80435CFAB5087F1A942543F51A5075BC441BF7EB
packetSize	Yes	size of encrypted packet in bytes	5242880
supervisorStatus	Yes	supervisor decision	APPROVED, REJECTED
supervisorComment	No	supervisor comments	rejected because of error
optionalValues	No	additional values to be passed during sync	key, value pair
langCode	Yes	language code used	eng or ara

Request Header

Center-Machine-RefId = 10011_10011

timestamp = 2019-02-14T12:40:59.768Z

Request

Response

Response Header

Response-Signature = <the response signature>

Success response

Response Code: 200

Description: Successfully synced

Failure response

Failure details

Error Code	Error Message	Error Description
RPR-AUT-002	Access Denied	Access Denied for the role
RPR-RGS-001	Unable to Access Registration Table	Unable to Access Registration Table
RPR-RGS-016	JSON Mapping Failed	JSON Mapping Failed
RPR-RGS-017	JSON Parsing Failed	JSON Parsing Failed
RPR-SYS-002	Bad Gateway	Bad Gateway
RPR-DBE-001	Data integrity violation exception	Data integrity violation exception
RPR-AUT-01	Invalid Token Present	Invalid Token Present
RPR-RGS-015	Invalid Request Value - Input Data is Incorrect	Invalid Request Value - Input Data is Incorrect

4 Manual Adjudication APIs

4.1 Manual Adjudication Assignment API

This API is used to assign one single unassigned applicant record to the manual adjudicator.

POST /registrationprocessor/v1/manualverification/assignment

Resource URL

https://{base_url}/registrationprocessor/v1/manualverification/assignment

Resource details

Resource Details	Description
Request format	JSON
Response format	JSON
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
String	Yes	The user id

Request

Response

Success response

Status Code: 200

Description: response code is always 200 if server receives the request.

Failure response

Failure details

Error Code	Error Message	Error Description
RPR-MVS-005	fields can not be empty	fields can not be empty
RPR-MVS-004	No Assigned Record Found	No Assigned Record Found
RPR-MVS-006	Missing Input Parameter - requesttime	Missing Input Parameter - requesttime
RPR-MVS-007	Missing Input Parameter - id	Missing Input Parameter - id
RPR-MVS-008	Invalid Input Parameter - version	Invalid Input Parameter - version
RPR-MVS-011	Invalid Argument Exception	Invalid Argument Exception
RPR-MVS-012	Unknown Exception	Unknown Exception
RPR-MVS-013	Request Decoding Exception	Request Decoding Exception
RPR-MVS-017	User Id should not empty or null	User Id should not empty or null
RPR-MVS-015	User is not in ACTIVE status	User is not in ACTIVE status
RPR-MVS-020	Match Type is Invalid	Match Type is Invalid
RPR-MVS-022	TablenotAccessibleException in Manual verification	TablenotAccessibleException in Manual verification

4.2 Manual Adjudication Decision API

This API is used to get the decision from manual adjudicator for an applicant and update the decision in table. The packet is sent for further processing based on decision.

POST /registrationprocessor/v1/manualverification/decision

Resource URL

https://{base_url}/registrationprocessor/v1/manualverification/decision

Resource details

Resource Details	Description
Request format	JSON
Response format	JSON
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
ManualVerificationDTO	Yes	Dto containing manual adjudication info

Request

Response

Status Code: 200

Description: response code is always 200 if server receives the request.

Success response

Failure response

Failure details

Error Code	Error Message	Error Description
RPR-MVS-003	Invalid status update	Invalid status update
RPR-MVS-005	fields can not be empty	fields can not be empty
RPR-MVS-004	No Assigned Record Found	No Assigned Record Found
RPR-MVS-018	Packet Not Found in Packet Store	Packet Not Found in Packet Store
RPR-MVS-006	Missing Input Parameter - requesttime	Missing Input Parameter - requesttime
RPR-MVS-007	Missing Input Parameter - id	Missing Input Parameter - id
RPR-MVS-008	Invalid Input Parameter - version	Invalid Input Parameter - version
RPR-MVS-011	Invalid Argument Exception	Invalid Argument Exception
RPR-MVS-012	Unknown Exception	Unknown Exception
RPR-MVS-013	Request Decoding Exception	Request Decoding Exception
RPR-MVS-017	User Id should not empty or null	User Id should not empty or null
RPR-MVS-015	User is not in ACTIVE status	User is not in ACTIVE status
RPR-MVS-016	Reg Id should not be null or empty	Reg Id should not be null or empty
RPR-MVS-021	Manual verification rejected	Manual verification rejected
RPR-MVS-022	TablenotAccessibleException in Manual verification	TablenotAccessibleException in Manual verification

5 Bio Dedupe API

The abis would call bio-dedupe callback API to get the biometric cbeff file.

GET /registrationprocessor/v1/bio-dedupe/biometricfile/{referenceid}

Resource URL

https://{base_url}/registrationprocessor/v1/bio-dedupe/biometricfile/{referenceid}

Resource details

Resource Details	Description
Request format	JSON
Response format	byte[]
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
byte[]	Yes	byte array of CBEFF file

Response

Status codes: 200

Description: response code is always 200 if server receives the request.

Success Response

Failure Response

Failure details

Error Code	Error Message	Error Description
RPR-MVS-001	Access Denied	Access Denied for the role
RPR-AUT-01	Invalid Token Present	Invalid Token Present

6 Packet Generator API

The residence service portal would call packet generator API to activate or deactivate uin.

POST /registrationprocessor/v1/requesthandler/packetgenerator

Resource URL

https://{base_url}/registrationprocessor/v1/requesthandler/packetgenerator

Resource details

Resource Details	Description
Request format	JSON
Response format	JSON
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
PacketGeneratorRequestDto	Yes	Dto containing information required for activate or deactivate packet

Request

Response

Status Code:200

Description: response code is always 200 if server receives the request.

Success Response

Failure Response

Failure details

Error Code	Error Message	Error Description
RPR-MVS-001	Access Denied	Access Denied for the role
RPR-AUT-01	Invalid Token Present	Invalid Token Present
RPR-PGS-001	The Packet store set by the System is not accessible	The Packet store set by the System is not accessible
RPR-PGS-002	The key is invalid or illegal argument	The key is invalid or illegal argument
RPR-PGS-003	The Api resource is not available	The Api resource is not available
RPR-PGS-004	reg Based checked exception	reg Based checked exception
RPR-PGS-005	Exception while parsing object to JSON	Exception while parsing object to JSON
RPR-PGS-007	Exception occurred while encrypting the packet Invalid data	Exception occurred while encrypting the packet Invalid data
RPR-PGS-008	Exception occurred while encrypting the packet Invalid Key	Exception occurred while encrypting the packet Invalid Key
RPR-PGS-009	Packet meta info converter error	Packet meta info converter error
RPR-PGS-010	Missing Input Parameter	Missing Input Parameter
RPR-PGS-011	Invalid Input Parameter	Invalid Input Parameter
RPR-PGS-012	Input Data Validation Failed	Input Data Validation Failed

7 Packet Uploader API

The dmz camel-bridge calls packet uploader API to upload the packet in file system(Hdfs, ceph etc). This service is a bridge between dmz and secure network. It accepts json request and connects to dmz VM to get the packet and move it to archive location.

POST /registrationprocessor/v1/uploader/securezone

Resource URL

https://{base_url}/registrationprocessor/v1/uploader/securezone

Resource details

Resource Details	Description
Request format	JSON
Response format	String
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
MessageDto	Yes	Dto being transferred in each and every stage of reg-proc

Request

Response

Status Code:200

Description: response code is always 200 if server receives the request.

Success Response

Failure Response

8 Request Handler API

The residence service portal would call this api to reprint uin card upon receiving request from the applicant.

POST /registrationprocessor/v1/requesthandler/reprint

Resource URL

https://{base_url}/registrationprocessor/v1/requesthandler/reprint

Resource details

Resource Details	Description
Request format	JSON
Response format	JSON
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
id	Yes	reprint id	mosip.uincard.reprint
version	Yes	the version for sync	1.0
requesttime	Yes	the requesttime for sync	2019-02-14T12:40:59.768Z
request	Yes	the request object	1.0
cardType	Yes	the type of the card	'UIN' OR 'MASKED_UIN'
idType	Yes	type of id provided	'UIN' OR 'VID'
id	Yes	the id provided	5647294083
registrationType	Yes	This indicates the registration type in registration processor. The camel route is decided based on this	RES_REPRINT
centerId	Yes	center id required to create packet	10003
machineId	Yes	machine id required to create packet	10003
reason	No	The reason for reprint	Any string

Request

Response

Status Code:200

Description: response code is always 200 if server receives the request.

Success Response

Failure response

Failure details

Error Code	Error Message	Error Description
RPR-MVS-001	Access Denied	Access Denied for the role
RPR-AUT-01	Invalid Token Present	Invalid Token Present
RPR-PGS-001	The Packet store set by the System is not accessible	The Packet store set by the System is not accessible
RPR-PGS-002	The key is invalid or illegal argument	The key is invalid or illegal argument
RPR-PGS-003	The Api resource is not available	The Api resource is not available
RPR-PGS-004	reg Based checked exception	reg Based checked exception
RPR-PGS-005	Exception while parsing object to JSON	Exception while parsing object to JSON
RPR-PGS-007	Exception occurred while encrypting the packet Invalid data	Exception occurred while encrypting the packet Invalid data
RPR-PGS-008	Exception occurred while encrypting the packet Invalid Key	Exception occurred while encrypting the packet Invalid Key
RPR-PGS-009	Packet meta info converter error	Packet meta info converter error
RPR-PGS-010	Missing Input Parameter	Missing Input Parameter
RPR-PGS-011	Invalid Input Parameter	Invalid Input Parameter
RPR-PGS-012	Input Data Validation Failed	Input Data Validation Failed

9 Registration Transaction API

This API is used to find all the transactions for a registration id. This service accepts a registration id and returns all transactions associated with it.

Resource URL

GET /registrationprocessor/v1/registrationtransaction/search/{langcode}/{rid}

Resource details

Resource Details	Description
Response format	JSON
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
langcode	Yes	The language code
registrationId	Yes	The registration id

Request

Response

Scenario: Record found

Status Code: 200

Description: Successfully retrieved information

Scenario: Record not found

Status Code: 200

Description: Successfully retrieved information

Failure details

Error Code	Error Message	Error Description
RPR-MVS-001	Access Denied	Access Denied for the role
RPR-AUT-01	Invalid Token Present	Invalid Token Present
RPR-RTS-001	RID Not Found	RID Not Found
RPR-RTS-002	Unknown Exception occurred	Unknown Exception occurred
RPR-RTS-003	Invalid request	Invalid request
RPR-RTS-004	globalMessages not found for input langCode	globalMessages not found for input langCode

10 UIN Card API

The residence service portal would call this API to get uin card upon receiving request from the applicant.

POST /registrationprocessor/v1/print/uincard

Resource URL

https://{base_url}/registrationprocessor/v1/print/uincard

Resource details

Resource Details	Description
Request format	JSON
Response format	application/pdf
Error Response format	JSON
Requires Authentication	Yes

Parameters

Name	Required	Description	Comment
id	Yes	reprint id	mosip.print
version	Yes	the version	1.0
requesttime	Yes	the requesttime	2019-02-14T12:40:59.768Z
request	Yes	the request object	1.0
cardType	Yes	the type of the card	'UIN' OR 'MASKED_UIN'
idType	Yes	type of id provided	'UIN' OR 'VID' OR 'RID'
idValue	Yes	the id provided	5647294083

Request

Response

Status Code:200

Description: response code is always 200 if server receives the request.

Success response

Failure response

Failure details

Error Code	Error Message	Error Description
RPR-MVS-001	Access Denied	Access Denied for the role
RPR-AUT-01	Invalid Token Present	Invalid Token Present
RPR-PRT-001	Error while generating PDF for UIN Card	Error while generating PDF for UIN Card
RPR-PRT-002	UIN not found in database	UIN not found in database
RPR-PRT-003	PDF Generation Failed	PDF Generation Failed
RPR-PRT-004	Queue connection is null	Queue connection is null
RPR-PRT-005	Error while generating QR Code	Error while generating QR Code
RPR-PRT-006	Error while setting applicant photo	Error while setting applicant photo
RPR-PRT-007	Error while setting qrCode for uin card	Error while setting qrCode for uin card
RPR-PRT-008	ID Repo response is null	ID Repo response is null
RPR-PRT-009	ID Repo response has no documents	ID Repo response has no documents
RPR-PRT-011	Error while print data validation	Error while print data validation
RPR-PRT-012	Invalid CardType : Enter UIN or MASKED_UIN