Getting Started: A Quick introduction to building powerful apps with Prudential APIs

How to access Prudential APIs?

Prudential APIs are private APIs, and each API call needs to be authenticated by an approved authentication method.

To subscribe to an API, the developer must register an app in the API portal. That subscription request would be reviewed by the API Owner, and if approved, then the credentials for that app can be used to call the API.

There are different API developer portals for each environment. The environment the app was created in will only have access to APIs in that environment. Below are the links for each environment

Step 1: Login to the portal

1. If you have an Existing Account

Your organization is a Prudential partner and you have an active API Portal Account

• Use your existing username and password credentials to login to your account

2. If you are an Existing Partner

Your organization is a Prudential partner but you are not yet to register for an API portal account

• Reach out to your organization POC to get your account created

• Register and activate your account through the email invitation link. Please use a business email when creating your account.

• Login to your account. As a first-time user, to complete the login successfully, the user will get an authentication code sent to the registered business email. The user should enter the code in the screen to login.

  For More Information on How to Get Access Click Here

3. If you are a To Be Partner

Your organization is not a Prudential partner for API sharing

• For group insurance inquiries reach out to the Benefits Technology & Integrations Team

• Once your organization signs the vendor agreement documents, you would get account registration links through email. Please use a business email when creating your account.

• Login to your account. As a first-time user, to complete the login successfully, the user will get an authentication code sent to the registered business email. The user should enter the code in the screen to login.

  For More Information on How to Get Access Click Here

Step 2: Key Portal Functionalities

1. Explore APIs :-

• Once logged in, you will land on the API Catalog page.
• Then you can search APIs by name, filter APIs by categories and sort the results.
• Once you find the API of your interest, click the API card to view the API Spec Page.

2. Request Access (Subscribe to an API) :-

• On an API Spec Page, click on the "Request Access to API" button to send an access request to the API Owner.
• You need to register a new app or map an existing app in order to place the API access request.

3. API Access Approval :-

• Once API access request is sent, it would be reviewed by the API Owner and if approved you would have access to call that API.

Existing API Security Guidelines require that the Client Applications that access APIs must be authenticated by an approved authentication method. Click here to know more about App Security Guidelines to access API