When request is received by the emCA service, we will decrypt the request JSON Object with the same AES key that is shared to the client.
After successful decryption, request JSON object (Subject DN details, Key algorithm & Size, PFX password) + Username + Password+ Profile ID+ Application ID + Valid From + Validity + Subscriber ID) is retrieved.
First emCA service will validate username and password and check if the IP Address used for request and registered with the user are same.
If request is registered with the same user, then we check if the certificate is already created for requested applicationId or not.
If certificate is already created for applicationId then return existing certificate.
If certificate is not created for applicationId then we create certificate using next step.
If it is same then (signature data) is validated by checking whether user info i.e. (Subject DN details, key algorithm & size, pfx password) is signed by the same pfx which is registered for the specific user.
If validation fails at any point in processing the request, the emCA service will throw error/failure message.
Response Parameters
JSON Object Contains below parameters
Response JSON Format
Sample:
Success:
Response Body(Is Manual Authorization Enabled is “not“ checked from emCA)
{
"status":"success",
"result":" base 64 encoded PFX data"
“subscriberId”:”XXX” "requestId": null
}
Response Body (Is Manual Authorization Enabled is checked from emCA )
{
"status": "Success",
"result": " your request proceded sucssusfully", "subscriberId": "XXXX",
"requestId": “XXXX”
}
Failure:
{
"status":"failure", "result":"<Error message>" “subscriberId”:null "requestId": null
}
You need to pass username that is registered with emCA for API process.
password
M
String
You need to pass the password that is registered with emCA for API process.
profileID
M
String
Pass Certificate profile name to be used to create PFX file.
subscriberId
M
String
Pass the Subscriber ID.
validity
O
String
Pass the validity in the form of (Days : Hours : Minutes : Seconds)
Days – 36135 (maximum days)
Hours - 23 (max hours)
Minutes - 59 (max minutes)
Seconds - 59 (max seconds)
to create certificate with the given validity.
validFrom
O
String
Pass the valid from, in the form of (Days : Hours : Minutes : Seconds).
applicationId
M
String
Pass application ID.
Parameter
Presence
Data Type
Description
requestData
M
String
All the request input parameters mentioned above should be converted to JSON object and encrypted with AES 256 key shared with you by emCA team.
Pass Encrypted JSON Object.
userName
M
String
You need to pass username that is registered with emCA for API process.
Key
Presence
Value
Description
Application / JSON
M
Content-Type
Type of request should be in JSON Format.
Authentication Key
M
emKey
emKey is an encoded key (Refer section 4 for generating Authentication Key using command prompt).
Parameter
Data Type
Description
response
String
Returns JSON Object
Parameter
Data Type
Description
status
String
Returns Status of the request as success if pfx(PKCS#12) is generated using selected certificate profile.
Returns status of the request as failure when authentication fails or unregistered user tries to call the API
result
String
Returns
In case of success: Base 64 encoded PFX data
In case of failure: error message will be displayed.
subscriberId
String
Returns Subscriber Id
requestid
String
Return request ID when user is manually authorized and request accepted successfully, otherwise it will return null.
Error Message
Description
Profile does not exist
If the given certificate profile Id is invalid
Signature verification failed
If signature parameter (user info) contains invalid user details (Subject DN details, key algorithm & size, pfx password) signed by pfx which is shared by eMudhra.
Invalid validity
validity should be in proper format dd:hh:mm:ss e.g: 120:23:45:54
Invalid From Date
Invalid Input: From Date should be in proper format dd:MM:YYYY hh:mm:ss e.g: 12:12:2019 00:00:00
