Integrate eSign into your systems.

Get access token

POST/api/auth/signin

Authenticate your business app with its client credentials. Use the returned access token as a Bearer token in the other calls.

Headers

Request body

Response

Example request

curl -X POST "https://staging-esign.bcc-ca.gov.bd:8443/api/auth/signin" \
  -H "Content-Type: application/json" \
  -d '{
  "username": "<client-username>",
  "password": "<client-password>"
}'

Example response · 200 Success

{
  "id": 17,
  "username": "<client-username>",
  "email": "client@example.com",
  "roles": [
    "ROLE_USER"
  ],
  "accessToken": "<access-token>",
  "tokenType": "Bearer"
}

Example response · 200 Invalid credentials

{
  "statusCode": 0,
  "statusText": null,
  "datetime": "2022-10-25 07:01:07 AM",
  "status": false,
  "data": null,
  "message": "Error: Username or password is invalid",
  "path": null
}

Get user certificate

POST/api/v1/user-certificate

Fetch the signer’s certificate. Use the certificate to build the digest, and pass key_alias as credId when you sign.

Headers

Request body

Response data

Example request

curl -X POST "https://staging-esign.bcc-ca.gov.bd:8443/api/v1/user-certificate" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -d '{
  "userId": "01XXXXXXXXX"
}'

Example response · 200 Success

{
  "statusCode": 200,
  "statusText": "OK",
  "datetime": "2022-10-27 12:22:36 PM",
  "status": true,
  "data": {
    "user_id": "01XXXXXXXXX",
    "key_alias": "01XXXXXXXXX_<uuid>",
    "key_status": "ACTIVE",
    "certificate": "<base64-certificate>",
    "certificate_chain": "<base64-certificate-chain>"
  }
}

Example response · 400 User not found

{
  "statusCode": 400,
  "statusText": "BAD_REQUEST",
  "datetime": "2022-10-27 12:29:27 PM",
  "status": false,
  "data": null,
  "message": "UserId doesn't exist - 123456",
  "path": null
}

Sign data or digest

POST/api/v1/sign

Request a signature on a digest you calculated in your business app. The user must authorise the request in QuickPass before the signature is returned.

• Calculate the digest of the PDF or XML document in your business app, using the user certificate.
• Pass the key_alias from Get user certificate as credId.
• The data type is always HASH, so there is no dataType parameter.

Headers

Request body

Response data

Example request

curl -X POST "https://staging-esign.bcc-ca.gov.bd:8443/api/v1/sign" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -H "id-token: <id-token>" \
  -d '{
  "userId": "01XXXXXXXXX",
  "tranId": "123456",
  "credId": "<key_alias>",
  "documentName": "test name",
  "inputData": "MUswGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAvBgkqhkiG9w0BCQQxIgQgP5zPV3pkDnR3G4BPWUajE1gicNR1xOpVbODgUlHm7S8="
}'

Example response · 200 Success

{
  "statusCode": 200,
  "statusText": "OK",
  "datetime": "2023-08-11 01:48:48 AM",
  "status": true,
  "data": {
    "userId": "01XXXXXXXXX",
    "tranId": "123456",
    "signature": "<base64-signature>"
  },
  "message": "Signing is successful",
  "path": "/api/v1/sign"
}

Example response · 400 Invalid credential

{
  "statusCode": 400,
  "statusText": "BAD_REQUEST",
  "datetime": "2022-10-25 08:28:03 AM",
  "status": false,
  "data": null,
  "message": "Invalid CredId - <credId> Please try with a valid certificate",
  "path": null
}

Example response · 400 Invalid digest

{
  "statusCode": 400,
  "statusText": "BAD_REQUEST",
  "datetime": "2022-10-25 08:28:21 AM",
  "status": false,
  "data": null,
  "message": "Failed to process request - DTBS is an invalid base64 data",
  "path": null
}

Bulk sign

POST/api/v1/bulk/sign

Request signatures on several digests for the same user and credential in one call.

Headers

Request body

Example request

curl -X POST "https://staging-esign.bcc-ca.gov.bd:8443/api/v1/bulk/sign" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -H "id-token: <id-token>" \
  -d '{
  "userId": "01XXXXXXXXX",
  "credId": "<key_alias>",
  "tranId": "123456",
  "data": [
    {
      "documentName": "test name",
      "inputData": "MUswGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAvBgkqhkiG9w0BCQQxIgQgP5zPV3pkDnR3G4BPWUajE1gicNR1xOpVbODgUlHm7S8="
    },
    {
      "documentName": "test name",
      "inputData": "MUswGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAvBgkqhkiG9w0BCQQxIgQgP5zPV3pkDnR3G4BPWUajE1gicNR1xOpVbODgUlHm7S8="
    }
  ]
}'

No example response is published for this endpoint.

Get user info (optional)

POST/api/v1/user/info

Look up a registered user’s details and status.

Headers

Request body

Response data

Example request

curl -X POST "https://staging-esign.bcc-ca.gov.bd:8443/api/v1/user/info" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -d '{
  "userId": "01XXXXXXXXX"
}'

Example response · 200 Success

{
  "statusCode": 200,
  "statusText": "OK",
  "datetime": "2024-05-09 01:46:53.128 PM",
  "status": true,
  "data": {
    "user_id": "01XXXXXXXXX",
    "user_name": "FULL NAME",
    "app_name": "SigningHubApp",
    "user_email": "user@example.com",
    "user_mobile": "+8801XXXXXXXXX",
    "status": "ACTIVE",
    "created_at": "2024-01-11 11:55:48",
    "profile_id": "adss:sam:profile:004"
  },
  "message": "User info is found",
  "path": null
}

Example response · 400 User not found

{
  "statusCode": 400,
  "statusText": "BAD_REQUEST",
  "datetime": "2022-10-27 12:29:27 PM",
  "status": false,
  "data": null,
  "message": "UserId doesn't exist - 123456",
  "path": null
}