Packet-Manager (1.0)

Download OpenAPI specification:Download

License: Mosip

Packet-Manager Service

packet-writer-controller

Packet Writer Controller

deleteTags

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TagRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"tagNames": ["string"
]
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

createPacket

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PacketDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"additionalInfoReqId": "string",
"refId": "string",
"offlineMode": true,
"process": "string",
"source": "string",
"schemaVersion": "string",
"schemaJson": "string",
"fields": {"property1": "string",
"property2": "string"
},
"metaInfo": {"property1": "string",
"property2": "string"
},
"documents": {"property1": {"document": ["string"
],
"value": "string",
"type": "string",
"format": "string",
"refNumber": "string"
},
"property2": {"document": ["string"
],
"value": "string",
"type": "string",
"format": "string",
"refNumber": "string"
}
},
"audits": [{"property1": "string",
"property2": "string"
}
],
"biometrics": {"property1": {"version": {"major": 0,
"minor": 0
},
"cbeffversion": {"major": 0,
"minor": 0
},
"birInfo": {"creator": "string",
"index": "string",
"payload": ["string"
],
"integrity": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z"
},
"segments": [{"version": {"major": 0,
"minor": 0
},
"cbeffversion": {"major": 0,
"minor": 0
},
"birInfo": {"creator": "string",
"index": "string",
"payload": ["string"
],
"integrity": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z"
},
"bdbInfo": {"challengeResponse": ["string"
],
"index": "string",
"format": {"organization": "string",
"type": "string"
},
"encryption": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z",
"type": ["SCENT"
],
"subtype": ["string"
],
"level": "RAW",
"product": {"organization": "string",
"type": "string"
},
"captureDevice": {"organization": "string",
"type": "string"
},
"featureExtractionAlgorithm": {"organization": "string",
"type": "string"
},
"comparisonAlgorithm": {"organization": "string",
"type": "string"
},
"compressionAlgorithm": {"organization": "string",
"type": "string"
},
"purpose": "VERIFY",
"quality": {"algorithm": {"organization": "string",
"type": "string"
},
"score": 0,
"qualityCalculationFailed": "string"
}
},
"bdb": ["string"
],
"sb": ["string"
],
"birs": [{ }
],
"sbInfo": {"format": {"organization": "string",
"type": "string"
}
},
"others": {"property1": "string",
"property2": "string"
}
}
],
"others": {"property1": "string",
"property2": "string"
}
},
"property2": {"version": {"major": 0,
"minor": 0
},
"cbeffversion": {"major": 0,
"minor": 0
},
"birInfo": {"creator": "string",
"index": "string",
"payload": ["string"
],
"integrity": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z"
},
"segments": [{"version": {"major": 0,
"minor": 0
},
"cbeffversion": {"major": 0,
"minor": 0
},
"birInfo": {"creator": "string",
"index": "string",
"payload": ["string"
],
"integrity": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z"
},
"bdbInfo": {"challengeResponse": ["string"
],
"index": "string",
"format": {"organization": "string",
"type": "string"
},
"encryption": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z",
"type": ["SCENT"
],
"subtype": ["string"
],
"level": "RAW",
"product": {"organization": "string",
"type": "string"
},
"captureDevice": {"organization": "string",
"type": "string"
},
"featureExtractionAlgorithm": {"organization": "string",
"type": "string"
},
"comparisonAlgorithm": {"organization": "string",
"type": "string"
},
"compressionAlgorithm": {"organization": "string",
"type": "string"
},
"purpose": "VERIFY",
"quality": {"algorithm": {"organization": "string",
"type": "string"
},
"score": 0,
"qualityCalculationFailed": "string"
}
},
"bdb": ["string"
],
"sb": ["string"
],
"birs": [{ }
],
"sbInfo": {"format": {"organization": "string",
"type": "string"
}
},
"others": {"property1": "string",
"property2": "string"
}
}
],
"others": {"property1": "string",
"property2": "string"
}
}
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": [{"id": "string",
"packetName": "string",
"source": "string",
"process": "string",
"refId": "string",
"schemaVersion": "string",
"signature": "string",
"encryptedHash": "string",
"providerName": "string",
"providerVersion": "string",
"creationDate": "string"
}
],
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

setTags

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TagDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"tags": {"property1": "string",
"property2": "string"
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"tags": {"property1": "string",
"property2": "string"
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

updateTags

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TagDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"tags": {"property1": "string",
"property2": "string"
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"tags": {"property1": "string",
"property2": "string"
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

packet-reader-controller

Packet Reader Controller

validatePacket

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (InfoDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"source": "string",
"process": "string",
"bypassCache": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"valid": true
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

searchFields

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FieldDtos)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"fields": ["string"
],
"source": "string",
"process": "string",
"bypassCache": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"fields": {"property1": "string",
"property2": "string"
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

searchField

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FieldDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"field": "string",
"source": "string",
"process": "string",
"bypassCache": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"fields": {"property1": "string",
"property2": "string"
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

getMetaInfo

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (InfoDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"source": "string",
"process": "string",
"bypassCache": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"fields": {"property1": "string",
"property2": "string"
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

info

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (InfoRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"applicationId": "string",
"packetId": "string",
"requestToken": "string",
"info": [{"source": "string",
"process": "string",
"lastModified": "2019-08-24T14:15:22Z",
"demographics": ["string"
],
"biometrics": [{"type": "string",
"subtypes": ["string"
]
}
],
"documents": {"property1": "string",
"property2": "string"
}
}
],
"tags": {"property1": "string",
"property2": "string"
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

getTags

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TagRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"tagNames": ["string"
]
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"tags": {"property1": "string",
"property2": "string"
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

getDocument

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (DocumentDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"documentName": "string",
"source": "string",
"process": "string",
"bypassCache": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"document": ["string"
],
"value": "string",
"type": "string",
"format": "string",
"refNumber": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

getBiometrics

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (BiometricRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"person": "string",
"modalities": ["string"
],
"source": "string",
"process": "string",
"bypassCache": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"version": {"major": 0,
"minor": 0
},
"cbeffversion": {"major": 0,
"minor": 0
},
"birInfo": {"creator": "string",
"index": "string",
"payload": ["string"
],
"integrity": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z"
},
"segments": [{"version": {"major": 0,
"minor": 0
},
"cbeffversion": {"major": 0,
"minor": 0
},
"birInfo": {"creator": "string",
"index": "string",
"payload": ["string"
],
"integrity": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z"
},
"bdbInfo": {"challengeResponse": ["string"
],
"index": "string",
"format": {"organization": "string",
"type": "string"
},
"encryption": true,
"creationDate": "2019-08-24T14:15:22Z",
"notValidBefore": "2019-08-24T14:15:22Z",
"notValidAfter": "2019-08-24T14:15:22Z",
"type": ["SCENT"
],
"subtype": ["string"
],
"level": "RAW",
"product": {"organization": "string",
"type": "string"
},
"captureDevice": {"organization": "string",
"type": "string"
},
"featureExtractionAlgorithm": {"organization": "string",
"type": "string"
},
"comparisonAlgorithm": {"organization": "string",
"type": "string"
},
"compressionAlgorithm": {"organization": "string",
"type": "string"
},
"purpose": "VERIFY",
"quality": {"algorithm": {"organization": "string",
"type": "string"
},
"score": 0,
"qualityCalculationFailed": "string"
}
},
"bdb": ["string"
],
"sb": ["string"
],
"birs": [{ }
],
"sbInfo": {"format": {"organization": "string",
"type": "string"
}
},
"others": {"property1": "string",
"property2": "string"
}
}
],
"others": {"property1": "string",
"property2": "string"
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

getAudits

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (InfoDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"source": "string",
"process": "string",
"bypassCache": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": [{"fields": {"property1": "string",
"property2": "string"
}
}
],
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Home

Packet-Manager (1.0)

packet-writer-controller

deleteTags

Request Body schema: application/json

Responses

Request samples

Response samples

createPacket

Request Body schema: application/json

Responses

Request samples

Response samples

setTags

Request Body schema: application/json

Responses

Request samples

Response samples

updateTags

Request Body schema: application/json

Responses

Request samples

Response samples

packet-reader-controller

validatePacket

Request Body schema: application/json

Responses

Request samples

Response samples

searchFields

Request Body schema: application/json

Responses

Request samples

Response samples

searchField

Request Body schema: application/json

Responses

Request samples

Response samples

getMetaInfo

Request Body schema: application/json

Responses

Request samples

Response samples

info

Request Body schema: application/json

Responses

Request samples

Response samples

getTags

Request Body schema: application/json

Responses

Request samples

Response samples

getDocument

Request Body schema: application/json

Responses

Request samples

Response samples

getBiometrics

Request Body schema: application/json

Responses

Request samples

Response samples

getAudits

Request Body schema: application/json

Responses

Request samples

Response samples

Home