Resident Services API documentation (1.0)

Download OpenAPI specification:Download

License: Mosip

Resident Services API documentation

resident-controller

Resident Controller

getRidStatus

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (RequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"individualId": "string",
"individualIdType": "string"
}
}

updateUin

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (ResidentUpdateRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"individualIdType": "string",
"otp": "string",
"identityJson": "string",
"documents": [{"name": "string",
"value": "string"
}
]
}
}

reqPrintUin Deprecated

reqPrintUin

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (ResidentReprintRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"individualIdType": "string",
"cardType": "string",
"otp": "string"
}
}

reqEuin Deprecated

reqEuin

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (EuinRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"individualIdType": "string",
"cardType": "string",
"otp": "string"
}
}

reqAuthUnlock

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (AuthUnLockRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"otp": "string",
"authType": ["string"
],
"unlockForSeconds": "string"
}
}

reqAauthLock

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (AuthLockOrUnLockRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"otp": "string",
"authType": ["string"
]
}
}

reqAuthHistory

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (AuthHistoryRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"otp": "string",
"pageStart": "string",
"pageFetch": "string"
}
}

resident-vid-controller

Resident Vid Controller

generateVid

Request Body schema: application/json

id	string
version	string
requesttime	string
	object (VidRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"otp": "string",
"vidType": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"vid": "string",
"message": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

revokeVid

path Parameters

vid

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (VidRevokeRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"individualIdType": "string",
"otp": "string",
"vidStatus": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"message": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

resident-credential-controller

Resident Credential Controller

getPolicyByCredentialType

path Parameters

partnerId required	string
credentialType required	string

Responses

reqCredential

Request Body schema: application/json

id	string
version	string
requesttime	string
required	object (ResidentCredentialRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "string",
"request": {"transactionID": "string",
"individualId": "string",
"otp": "string",
"credentialType": "string",
"encrypt": true,
"issuer": "string",
"encryptionKey": "string",
"recepiant": "string",
"user": "string",
"sharableAttributes": ["string"
],
"additionalData": {"property1": { },
"property2": { }
}
}
}

getCredentialStatus

path Parameters

requestId

required

string

Responses

cancelCredentialRequest

path Parameters

requestId

required

string

Responses

getCard

path Parameters

requestId

required

string

Responses

getCredentialTypes

Responses

resident-otp-controller

Resident Otp Controller

reqOtp

Request Body schema: application/json

id	string
version	string
transactionID	string
requestTime	string
individualId	string
otpChannel	Array of strings
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"transactionID": "string",
"requestTime": "string",
"individualId": "string",
"otpChannel": ["string"
],
"metadata": {"property1": { },
"property2": { }
}
}

Home

Resident Services API documentation (1.0)

resident-controller

getRidStatus

Request Body schema: application/json

Responses

Request samples

updateUin

Request Body schema: application/json

Responses

Request samples

reqPrintUin Deprecated

Request Body schema: application/json

Responses

Request samples

reqEuin Deprecated

Request Body schema: application/json

Responses

Request samples

reqAuthUnlock

Request Body schema: application/json

Responses

Request samples

reqAauthLock

Request Body schema: application/json

Responses

Request samples

reqAuthHistory

Request Body schema: application/json

Responses

Request samples

resident-vid-controller

generateVid

Request Body schema: application/json

Responses

Request samples

Response samples

revokeVid

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

resident-credential-controller

getPolicyByCredentialType

path Parameters

Responses

reqCredential

Request Body schema: application/json

Responses

Request samples

getCredentialStatus

path Parameters

Responses

cancelCredentialRequest

path Parameters

Responses

getCard

path Parameters

Responses

getCredentialTypes

Responses

resident-otp-controller

reqOtp

Request Body schema: application/json

Responses

Request samples

Home