EPFO Reference Guide

This document highlights the steps using which Businesses can integrate the EPF Solution. The APIs are completely RESTful and all our responses are returned in JSON.

API Gateway URL

Test Mode : https://api.overwatch.stg.bureau.id/
Live Mode : https://api.overwatch.bureau.id/

Authentication

All our API's are authenticated via an API key and secret, they have to be base64 encoded and sent in the header with the parameter name as Authorization.
Eg: Authorization : Basic ZTIxxxxmNA==

Flow

The flow consists of 3 steps, and requires consent of the user.

  • Fetch the UAN - The user UAN can be fetched from the Mobile Number, In case the user's UAN is already know this step can be skipped.
  • Send OTP - Use the UAN to initiate the transaction to fetch the EPFO passbook, In case the UAN is correct/exists an OTP will be sent to the customer and a transactionId and consentId is returned in the response.
  • Fetch Passbook - The transactionId , consentId and the otp received by the customer has to be sent in the third API call to fetch the user's passbook.

Fetch UAN

Request

curl --location --request POST
'https://api.overwatch.stg.bureau.id/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: BasicNDE4MmI30MjY1YQ=='\
--data-raw '{
      "workflowId": "585274d2-xxxx-4183-xxxx-071d778c640f",
      "data": {"phoneNumber":"874xxx196"}
  }'
curl --location --request POST
'https://api.overwatch.bureau.id/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: BasicNDE4MmI30MjY1YQ=='\
--data-raw '{
      "workflowId": "585274d2-xxxx-4183-xxxx-071d778c640f",
      "data": {"phoneNumber":"874xxx196"}
  }'

Request Description

KeyValueDescription
workflowId (Mandatory)A unique string of 32 charactersThis will be shared by the Bureau team and will remain a constant.
phoneNumber
(Mandatory)
StringThe phone number of the user without the country code.

Response

{
    "statusCode": 200,
    "error": "",
    "status": "OK",
    "timestamp": 1665029389563,
    "transactionId": "f53fdc68-xxxx-4504-xxxx-d2f0c0e41a06",
    "merchantId": "auth0|61xxxxxe7021",
    "entityId": "fdaa0c40-7728-4699-8891-fa115ef8bd09",
    "entityType": "",
    "workflowId": "5903636d-xxxx-47d4-xxxx-4bb39cafa680",
    "entityName": "",
    "workflowName": "EPFUAN 1/2",
    "tags": {},
    "outcome": "ACCEPTED",
    "transactionTimeline": [
        {
            "index": 1,
            "updatedAt": 1665029389563,
            "updatedBy": "",
            "outcome": "ACCEPTED",
            "comments": ""
        }
    ],
    "services": {
        "Fetch UAN": {
            "status": "OK",
            "response": {
                "conditionsEvaluationStatus": true,
                "error": null,
                "status": "OK",
                "uanList": [
                    1xxxxxx3458
                ]
            }
        }
    },
    "awaits": {},
    "outcomeReasons": [],
    "transactionRawInput": {
        "merchantId": "",
        "phoneNumber": "8xxxxx6"
    },
    "documents": [],
    "devices": []
}


{
    "statusCode": 200,
    "error": "",
    "status": "OK",
    "timestamp": 1665029666967,
    "transactionId": "edxxx243-xx88-4xx4-8xx8-ae2xxxxxee3",
    "merchantId": "auth0|6xxxx1be7021",
    "entityId": "ddxxxcb-e70c-4xx0-a9c5-5f4dxxxxe84",
    "entityType": "",
    "workflowId": "5xxxx6d-7xx7-47xx-xx61-4bbxxxx680",
    "entityName": "",
    "workflowName": "EPFUAN 1/2",
    "tags": {},
    "outcome": "REJECTED",
    "transactionTimeline": [
        {
            "index": 1,
            "updatedAt": 1665029666967,
            "updatedBy": "",
            "outcome": "REJECTED",
            "comments": ""
        }
    ],
    "services": {
        "Fetch UAN": {
            "status": "NO_RECORD_FOUND",
            "response": {
                "conditionsEvaluationStatus": true,
                "error": {
                    "code": 422,
                    "description": "",
                    "message": "NO_RECORD_FOUND"
                },
                "status": "NO_RECORD_FOUND",
                "uanList": null
            }
        }
    },
    "awaits": {},
    "outcomeReasons": [],
    "transactionRawInput": {
        "merchantId": "",
        "phoneNumber": "984xxxx49"
    },
    "documents": [],
    "devices": []
}
{
    "statusCode": 200,
    "error": "",
    "status": "OK",
    "timestamp": 1665030252446,
    "transactionId": "2a2b6fd3-e369-4xx1-a822-dc8b0f696372",
    "merchantId": "auth0|61xxxxx071be7021",
    "entityId": "50403652-xxxx-4444-xxxx-d86503e318e0",
    "entityType": "",
    "workflowId": "5903636d-7d87-47d4-b961-4bb39cafa680",
    "entityName": "",
    "workflowName": "EPFUAN 1/2",
    "tags": {},
    "outcome": "REJECTED",
    "transactionTimeline": [
        {
            "index": 1,
            "updatedAt": 1665030252446,
            "updatedBy": "",
            "outcome": "REJECTED",
            "comments": ""
        }
    ],
    "services": {
        "Fetch UAN": {
            "status": "FAILED",
            "response": {
                "conditionsEvaluationStatus": true,
                "error": {
                    "code": 400,
                    "description": "PhoneNumber should be 10 digits",
                    "message": "BAD_REQUEST"
                },
                "status": "FAILED",
                "uanList": null
            }
        }
    },
    "awaits": {},
    "outcomeReasons": [],
    "transactionRawInput": {
        "merchantId": "",
        "phoneNumber": "984504524111"
    },
    "documents": [],
    "devices": []
}


{
    "statusCode": 200,
    "error": "",
    "status": "OK",
    "timestamp": 1665029389563,
    "transactionId": "f53fdc68-xxxx-4504-xxxx-d2f0c0e41a06",
    "merchantId": "auth0|61dfbb6dfd33420071be7021",
    "entityId": "fdaa0c40-7728-4699-8891-fa115ef8bd09",
    "entityType": "",
    "workflowId": "5903636d-xxxx-47d4-xxxx-4bb39cafa680",
    "entityName": "",
    "workflowName": "EPFUAN 1/2",
    "tags": {},
    "outcome": "ACCEPTED",
    "transactionTimeline": [
        {
            "index": 1,
            "updatedAt": 1665029389563,
            "updatedBy": "",
            "outcome": "ACCEPTED",
            "comments": ""
        }
    ],
    "services": {
        "Fetch UAN": {
            "status": "OK",
            "response": {
                "conditionsEvaluationStatus": true,
                "error": null,
                "status": "OK",
                "uanList": [
                    10xxxxx3458,
                    10xxxxx2152
                ]
            }
        }
    },
    "awaits": {},
    "outcomeReasons": [],
    "transactionRawInput": {
        "merchantId": "",
        "phoneNumber": "8xxxxx6"
    },
    "documents": [],
    "devices": []
}
{
  "message": "Endpoint request timed out"
 }

Response Description

ScenarioCodeRetriableDescription
SuccessOK--In case of a successful fetch of UAN against a phone number, Fetch UAN service will respond with status as OK and the UAN list will be populated with the available UAN’s against the phone number.
No UAN422NoIn case there are no UAN's associated with a particular phone number, the Fetch UAN service will return the message NO_RECORD_FOUND and the uanList returns null.
Bad Request400Retry with the correct ParametersRequest Failing because of incorrect Parameters, retry with the correct parameters.
Multiple UAN'sOK--Multiple UAN's are returned for a particular phone number.
Timeout408 (HTTPS)YesIn case there is a timeout even after retry and this is happening for more than 15 requests, it is advisable to wait for 10-15 minutes before the next retry.

Send OTP

Request

curl --location --request POST 'https://api.overwatch.stg.bureau.id/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic NThhMDxxxxxMxNTg2NA==' \
--data-raw '{
      "workflowId": "387705d4-xxxx-46cc-xxxx-ab21790fcb83",
      "data": {"uan":"101xxxx3458"}
}'
curl --location --request POST 'https://api.overwatch.bureau.id/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic NThhMDxxxxxMxNTg2NA==' \
--data-raw '{
      "workflowId": "387705d4-xxxx-46cc-xxxx-ab21790fcb83",
      "data": {"uan":"101xxxx3458"}
}'

Request Description

KeyValueDescription
workflowId
(Mandatory)
A unique string of 32 charactersThis will be shared by the Bureau team and will remain a constant.
uan
(Mandatory)
StringThis is shared as part of the response in the previous request.

Response

{
    "statusCode": 200,
    "error": "",
    "status": "AWAITING",
    "timestamp": 1665638721854,
    "transactionId": "0d583eab-1xxa-4be0-xxx0-07c2d4a306ec",
    "merchantId": "auth0|61dxxxx0071be7021",
    "entityId": "0dxxxc4-cxx4c-4500-8xx2-3921xxxx7fa",
    "entityType": "",
    "workflowId": "886xxx52-0xxa-4c79-xxf-f75xxxc52bf",
    "entityName": "",
    "workflowName": "EPF Test 01 2/2",
    "tags": {},
    "outcome": "AWAITING",
    "transactionTimeline": [
        {
            "index": 1,
            "updatedAt": 1665638721854,
            "updatedBy": "",
            "outcome": "AWAITING",
            "comments": ""
        }
    ],
    "services": {
        "EPF Authentication Get Details": {
            "status": "NOT_EXECUTED",
            "response": null
        },
        "EPF Authentication Send OTP": {
            "status": "OK",
            "response": {
                "conditionsEvaluationStatus": true,
                "consentId": "2d61acea-9xx6-4b95-xx09-bdxxxef8e5",
                "error": null,
                "status": "OK"
            }
        }
    },
    "awaits": {
        "Awaits": {
            "status": "OK",
            "response": {
                "data": [
                    {
                        "displayName": "Consent ID",
                        "key": "consentId",
                        "set": false
                    },
                    {
                        "displayName": "OTP",
                        "key": "otp",
                        "set": false
                    }
                ]
            }
        }
    },
    "outcomeReasons": [],
    "transactionRawInput": {
        "merchantId": "",
        "uan": "10xxxx58"
    },
    "documents": [],
    "devices": []
}
{
    "statusCode": 200,
    "error": "",
    "status": "AWAITING",
    "timestamp": 1665584000203,
    "transactionId": "6fxxxxf0-bxxd-4xxb-axx9-bc7cxxxxx8",
    "merchantId": "auth0|61dfxxxxxx71be7021",
    "entityId": "dxxxx094-cxxb-41xe-8xx9-6fxxxxxx3",
    "entityType": "",
    "workflowId": "88xxxa52-xxea-4xxx9-9xxf-f75xxxbf",
    "entityName": "",
    "workflowName": "EPF Test 01 2/2",
    "tags": {},
    "outcome": "AWAITING",
    "transactionTimeline": [
        {
            "index": 1,
            "updatedAt": 1665584000203,
            "updatedBy": "",
            "outcome": "AWAITING",
            "comments": ""
        }
    ],
    "services": {
        "EPF Authentication Get Details": {
            "status": "NOT_EXECUTED",
            "response": null
        },
        "EPF Authentication Send OTP": {
            "status": "NO_RECORD_FOUND",
            "response": {
                "conditionsEvaluationStatus": true,
                "consentId": null,
                "error": {
                    "code": 422,
                    "description": "",
                    "message": "NO_RECORD_FOUND"
                },
                "status": "NO_RECORD_FOUND"
            }
        }
    },
    "awaits": {
        "Awaits": {
            "status": "OK",
            "response": {
                "data": [
                    {
                        "displayName": "Consent ID",
                        "key": "consentId",
                        "set": false
                    },
                    {
                        "displayName": "OTP",
                        "key": "otp",
                        "set": false
                    }
                ]
            }
        }
    },
    "outcomeReasons": [],
    "transactionRawInput": {
        "merchantId": "",
        "uan": "1xxxxx345"
    },
    "documents": [],
    "devices": []
}
{
    "statusCode": 200,
    "error": "",
    "status": "OK",
    "timestamp": 1665640781274,
    "transactionId": "exxxx4-cxx5-4xx2-bxx0-b5fxx2axf1",
    "merchantId": "auth0|61xxxxxxbe7021",
    "entityId": "806c031d-1xxx0-4xx2-9895-884xxx1ff8",
    "entityType": "",
    "workflowId": "8xxx52-0xxa-4xx9-9xxf-f7xxxx2bf",
    "entityName": "",
    "workflowName": "EPF Test 01 2/2",
    "tags": {},
    "outcome": "REJECTED",
    "transactionTimeline": [
        {
            "index": 1,
            "updatedAt": 1665640781274,
            "updatedBy": "",
            "outcome": "REJECTED",
            "comments": ""
        }
    ],
    "services": {
        "EPF Authentication Get Details": {
            "status": "NOT_EXECUTED",
            "response": null
        },
        "EPF Authentication Send OTP": {
            "status": "FAILED",
            "response": {
                "conditionsEvaluationStatus": true,
                "consentId": null,
                "error": {
                    "code": 443,
                    "description": "",
                    "message": "MAX_RETRIES_EXCEEDED"
                },
                "status": "FAILED"
            }
        }
    },
    "awaits": {
        "Awaits": {
            "status": "NOT_EXECUTED",
            "response": {
                "data": [
                    {
                        "displayName": "Consent ID",
                        "key": "consentId",
                        "set": false
                    },
                    {
                        "displayName": "OTP",
                        "key": "otp",
                        "set": false
                    }
                ]
            }
        }
    },
    "outcomeReasons": [],
    "transactionRawInput": {
        "merchantId": "",
        "uan": "1xxxxxx58"
    },
    "documents": [],
    "devices": []
}
{
    "message": "Endpoint request timed out"
} 
{
  "statusCode": 200,
  "error": "",
  "status": "OK",
  "timestamp": 1670420739732,
  "transactionId": "50xxxx0-0xxe-4xx5-b857-89xxxx3d58",
  "merchantId": "auth0|61xxxx7021",
  "entityId": "3xxxfb5-bxx8-4xxb-8xx8-34xxxxx7461",
  "entityType": "",
  "workflowId": "39xxxef-8xxe-4xx1-9xx1-ebxxxxc8b",
  "entityName": "",
  "workflowName": "project-hero-EPF 2/2",
  "tags": {},
  "outcome": "REJECTED",
  "transactionTimeline": [
    {
      "index": 1,
      "updatedAt": 1670420739732,
      "updatedBy": "",
      "outcome": "REJECTED",
      "comments": ""
    }
  ],
  "services": {
    "EPF Authentication Get Details": {
      "status": "NOT_EXECUTED",
      "response": null
    },
    "EPF Authentication Send OTP": {
      "status": "FAILED",
      "response": {
        "conditionsEvaluationStatus": true,
        "consentId": "",
        "error": {
          "code": 503,
          "description": "",
          "message": "INTERNAL_SERVICE_UNAVAILABLE"
        },
        "status": "FAILED"
      }
    }
  },
  "awaits": {
    "Awaits": {
      "status": "NOT_EXECUTED",
      "response": {
        "awaitedOnThis": false,
        "data": [
          {
            "displayName": "Consent ID",
            "key": "consentId",
            "set": false
          },
          {
            "displayName": "OTP",
            "key": "otp",
            "set": false
          }
        ]
      }
    }
  },
  "outcomeReasons": [],
  "transactionRawInput": {
    "merchantId": "",
    "uan": "99xxxx996"
  },
  "documents": [],
  "devices": []
}

Response Description

ScenarioCodeRetriableChargeableDescription
Success200--YesUpon successful triggering of OTP, EPF Auth Send OTP service returns status as OK and consentId is shared.
No Account Found422NoYesNo Account found at the EPF Portal.
Multiple Attempts443Temporarily NoNoMultiple attempts were made and further retry cannot be made until cooling period of 24 hours.
Timeout408 (HTTPS)YesNoIn case there is a timeout even after retry and this is happening for more than 15 requests, it is advisable to wait for 10-15 minutes before the next retry.
Service Unavailable503YesNoThis occurs whenever there is issue at the source or degradation in the service.

Fetch Passbook

Request

curl --location --request POST 'https://api.overwatch.stg.bureau.id/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic NDEMjY1YQ==' \
--data-raw '{
      "workflowId": "585274d2-xxxx-4183-xxxx-071d778c640f"
      "data": {
       "consentId": "bdc30436-xxxx-4afa-xxxx-07f93c2e8441",
       "otp" : "772008"
   }
  }'
curl --location --request POST 'https://api.overwatch.bureau.id/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic NDEMjY1YQ==' \
--data-raw '{
      "workflowId": "585274d2-xxxx-4183-xxxx-071d778c640f"
      "data": {
       "consentId": "bdc30436-xxxx-4afa-xxxx-07f93c2e8441",
       "otp" : "772008"
   }
  }'

Request Description

KeyValueDescription
workflowId
(Mandatory)
A unique string of 32 charactersThis will be shared by the Bureau team and will remain a constant.
consentId
(Mandatory)
StringThis is shared as part of the response in the previous request.
otp
(Mandatory)
StringReceived by the customer on the registered phone number.

Response

{
	"statusCode": 200,
	"error": "",
	"status": "OK",
	"timestamp": 1665638721854,
	"transactionId": "0d583eab-xxxx-4be0-xxxx-07c2d4a306ec",
	"merchantId": "auth0|61dfbxxxxx0071be7021",
	"entityId": "73f7bc1e-e18d-4253-9a6d-7f09d2b0a41b",
	"entityType": "",
	"workflowId": "88694a52-xxxx-4c79-xxxx-f753615c52bf",
	"entityName": "",
	"workflowName": "EPF Test 01 2/2",
	"tags": {},
	"outcome": "ACCEPTED",
	"transactionTimeline": [{
		"index": 1,
		"updatedAt": 1665638721854,
		"updatedBy": "",
		"outcome": "ACCEPTED",
		"comments": ""
	}],
	"services": {
		"EPF Authentication Get Details": {
			"status": "OK",
			"response": {
				"conditionsEvaluationStatus": true,
				"employee_details": {
					"dob": "",
					"father_name": null,
					"member_name": null
				},
				"error": null,
				"est_details": [{
						"doe_epf": "",
						"doe_eps": "",
						"doj_epf": "",
						"est_name": "EXXX SXXXXES IXXXA",
						"member_id": "PYBOM00xxXxx1063320",
						"office": "None",
						"passbook": [{}],
						"pf_balance": {
							"employee_share": {
								"balance": 0,
								"credit": 0,
								"debit": 0
							},
							"employer_share": {
								"balance": 0,
								"credit": 0,
								"debit": 0
							},
							"is_pf_full_withdrawn": false,
							"is_pf_partial_withdrawn": false,
							"net_balance": 0
						}
					},
					{
						"doe_epf": "13-10-2022",
						"doe_eps": "13-10-2022",
						"doj_epf": "23-10-2019",
						"est_name": "RxxxxxY SxxxxxE PRIVATE LIMITED",
						"member_id": "BGBNG148xxxxxx010733",
						"office": "(RO)BANGALORE",
						"passbook": [{
								"approved_on": "09-12-2019",
								"cr_ee_share": "000",
								"cr_er_share": "000",
								"cr_pen_bal": "000",
								"db_cr_flag": "C",
								"month_year": "000",
								"particular": "Cont. For Due-Month 122019",
								"tr_approved": "13-10-2022",
								"tr_date_my": "01-12-2019"
							},
							{
								"approved_on": "10-12-2019",
								"cr_ee_share": "000",
								"cr_er_share": "000",
								"cr_pen_bal": "000",
								"db_cr_flag": "C",
								"month_year": "000",
								"particular": "Cont. For Due-Month 122019",
								"tr_approved": "13-10-2022",
								"tr_date_my": "01-12-2019"
							},
							{
								"approved_on": "13-01-2020",
								"cr_ee_share": "000",
								"cr_er_share": "000",
								"cr_pen_bal": "000",
								"db_cr_flag": "C",
								"month_year": "000",
								"particular": "Cont. For Due-Month 012020",
								"tr_approved": "13-10-2022",
								"tr_date_my": "01-01-2020"
							},
							{
								"approved_on": "11-02-2020",
								"cr_ee_share": "000",
								"cr_er_share": "000",
								"cr_pen_bal": "000",
								"db_cr_flag": "C",
								"month_year": "000",
								"particular": "Cont. For Due-Month 022020",
								"tr_approved": "13-10-2022",
								"tr_date_my": "01-02-2020"
							}
						],
						"pf_balance": {
							"employee_share": {
								"balance": "000",
								"credit": "000",
								"debit": 0
							},
							"employer_share": {
								"balance": "000",
								"credit": "000",
								"debit": 0
							},
							"is_pf_full_withdrawn": false,
							"is_pf_partial_withdrawn": false,
							"net_balance": 102225
						}
					},
					{
						"doe_epf": "13-10-2022",
						"doe_eps": "13-10-2022",
						"doj_epf": "01-01-2022",
						"est_name": "BURxxxxxDIA xxxxxMITED",
						"member_id": "THVSH21089180000010034",
						"office": "(SRO)VASHI",
						"passbook": [{
								"approved_on": "06-07-2022",
								"cr_ee_share": "000",
								"cr_er_share": "000",
								"cr_pen_bal": "000",
								"db_cr_flag": "C",
								"month_year": "000",
								"particular": "Cont. For Due-Month 052022",
								"tr_approved": "13-10-2022",
								"tr_date_my": "01-05-2022"
							},
							{
								"approved_on": "06-07-2022",
								"cr_ee_share": "000",
								"cr_er_share": "000",
								"cr_pen_bal": "000",
								"db_cr_flag": "C",
								"month_year": "000",
								"particular": "Cont. For Due-Month 062022",
								"tr_approved": "13-10-2022",
								"tr_date_my": "01-06-2022"
							}
						],
						"pf_balance": {
							"employee_share": {
								"balance": "000",
								"credit": "000",
								"debit": 0
							},
							"employer_share": {
								"balance": "000",
								"credit": "000",
								"debit": 0
							},
							"is_pf_full_withdrawn": false,
							"is_pf_partial_withdrawn": false,
							"net_balance": "000"
						}
					}
				],
				"overall_pf_balance": {
					"current_pf_balance": "000",
					"employee_share_total": {
						"balance": "000",
						"credit": "000",
						"debit": 0
					},
					"employer_share_total": {
						"balance": "000",
						"credit": "000",
						"debit": "000"
					},
					"pension_balance": "000"
				},
				"pdf": [{
						"est_id": "PYBxxxxx00",
						"pdf_data": "JVBEU9G"
					},
					{
						"est_id": "BGBxxxxx00",
						"pdf_data": "JgJVBEU9G=="
					},
					{
						"est_id": "THVSxxxxx8000",
						"pdf_data": "JVUJVBEU9G9G"
					}
				],
				"status": "OK"
			}
		},
		"EPF Authentication Send OTP": {
			"status": "OK",
			"response": {
				"conditionsEvaluationStatus": true,
				"consentId": "2d61acea-xxxx-4b95-xxxx-bd83368ef8e5",
				"error": null,
				"status": "OK"
			}
		}
	},
	"awaits": {
		"Awaits": {
			"status": "OK",
			"response": {
				"data": [{
						"displayName": "Consent ID",
						"key": "consentId",
						"set": true
					},
					{
						"displayName": "OTP",
						"key": "otp",
						"set": true
					}
				]
			}
		}
	},
	"outcomeReasons": [],
	"transactionRawInput": {
		"merchantId": "",
		"uan": "101xxxxx58"
	},
	"documents": [],
	"devices": []
}



{
  "statusCode": 200,
  "error": "",
  "status": "OK",
  "timestamp": 1670422994349,
  "transactionId": "dxx8be-9xx5-4xxf-9xxb7-4f6xxxxa8283",
  "merchantId": "auth0|6xxx071be7021",
  "entityId": "axxxxx2-bxx4-4xx8-9xxe-ec7xxx7",
  "entityType": "",
  "workflowId": "39xxxef-8xxe-4xx1-9xx1-exxxxxc8b",
  "entityName": "",
  "workflowName": "project-hero-EPF 2/2",
  "tags": {},
  "outcome": "REJECTED",
  "transactionTimeline": [
    {
      "index": 1,
      "updatedAt": 1670422994349,
      "updatedBy": "",
      "outcome": "REJECTED",
      "comments": ""
    }
  ],
  "services": {
    "EPF Authentication Get Details": {
      "status": "FAILED",
      "response": {
        "conditionsEvaluationStatus": true,
        "employee_details": null,
        "error": {
          "code": 400,
          "description": "Invalid otp or consentId",
          "message": "BAD_REQUEST"
        },
        "est_details": null,
        "overall_pf_balance": null,
        "pdf": null,
        "status": "FAILED"
      }
    },
    "EPF Authentication Send OTP": {
      "status": "FAILED",
      "response": {
        "conditionsEvaluationStatus": false,
        "consentId": "",
        "error": null,
        "status": "FAILED"
      }
    }
  },
  "awaits": {
    "Awaits": {
      "status": "OK",
      "response": {
        "awaitedOnThis": false,
        "data": [
          {
            "displayName": "Consent ID",
            "key": "consentId",
            "set": true
          },
          {
            "displayName": "OTP",
            "key": "otp",
            "set": true
          }
        ]
      }
    }
  },
  "outcomeReasons": [],
  "transactionRawInput": {
    "consentId": "9xxxc1-cxxe-4xxf-bxx5-6xxxx729",
    "merchantId": "",
    "otp": "7xxx08"
  },
  "documents": [],
  "devices": []
}
{
  "statusCode": 200,
  "error": "",
  "status": "OK",
  "timestamp": 1670423103653,
  "transactionId": "6xxd2bd-4xxb-4xxe-axx6-d5exxxx40a",
  "merchantId": "auth0|61dxxxx021",
  "entityId": "14xxx01-bxx6-4xxd-9xx5-1fxxxx57f",
  "entityType": "",
  "workflowId": "39xxef-8xxe-4xx1-9xx1-ebxxxc8b",
  "entityName": "",
  "workflowName": "project-hero-EPF 2/2",
  "tags": {},
  "outcome": "REJECTED",
  "transactionTimeline": [
    {
      "index": 1,
      "updatedAt": 1670423103653,
      "updatedBy": "",
      "outcome": "REJECTED",
      "comments": ""
    }
  ],
  "services": {
    "EPF Authentication Get Details": {
      "status": "FAILED",
      "response": {
        "conditionsEvaluationStatus": true,
        "employee_details": null,
        "error": {
          "code": 503,
          "description": "",
          "message": "INTERNAL_SERVICE_UNAVAILABLE"
        },
        "est_details": null,
        "overall_pf_balance": null,
        "pdf": null,
        "status": "FAILED"
      }
    },
    "EPF Authentication Send OTP": {
      "status": "FAILED",
      "response": {
        "conditionsEvaluationStatus": false,
        "consentId": "",
        "error": null,
        "status": "FAILED"
      }
    }
  },
  "awaits": {
    "Awaits": {
      "status": "OK",
      "response": {
        "awaitedOnThis": false,
        "data": [
          {
            "displayName": "Consent ID",
            "key": "consentId",
            "set": true
          },
          {
            "displayName": "OTP",
            "key": "otp",
            "set": true
          }
        ]
      }
    }
  },
  "outcomeReasons": [],
  "transactionRawInput": {
    "consentId": "5xx9-7xx6-4exc-9xx3-5exxxb1",
    "merchantId": "",
    "otp": "7xxx8"
  },
  "documents": [],
  "devices": []
}
{
    "message": "Endpoint request timed out"
}

Response Description

ScenarioCodeRetriableDescription
Success200--Upon successful attempt the EPF passbook of the user is returned.
Invalid OTP/Consent400NoThe OTP, consentID combination is incorrect.
Timeout408 (HTTPS)YesIn case there is a timeout, the request can be retried and based on the availability of the source the information can be fetched.
Service Unavailable503YesThis occurs whenever there is issue at the source or degradation in the service.

Outcome Possibilities

OutcomeDescription
ACCEPTEDThis indicates the execution of the workflow was successful.
REJECTEDThis indicates the execution of the workflow has failed.
AWAITINGThis indicates that the execution of workflow is waiting on one or more of the parameters, in this case it will be the OTP.