---
title: "Submit a new request for authentication"
method: POST
path: "/credentials/{credentialId}/authenticate"
tags: ["Credential Authentication"]
---

# Submit a new request for authentication

`POST /credentials/{credentialId}/authenticate`

## Request

- Base URL: `//basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1` (relative, and the document’s source URL is not known)
- URL: `//basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1/credentials/{credentialId}/authenticate`
- Auth: API key in header `Authorization`

Initiate the authentication operation for the credential specified by 'credentialId'. This operation does not require any payload nor does it return one. On success (200) the Location header will contain the temporary location to use to poll for status.

## Path parameters

- `credentialId` integer, required

## Query parameters

- `allowUserInput` boolean
- `startOauth` boolean

## Request body

- CredentialAuthenticationPostDto
  - `oauthRedirectURL` string: URL for BAA to redirect to after the Oauth process has fully completed. If not provided, then no redirect is issued (instead a self-closing HTML page is returned from the OauthCallbackHandler)
  - `oauthRedirectType` string: Type of redirect: 'client' for a JavaScript client-side redirect and 'server' for a 302 redirect. Not case-sensitive. If type is not included or not a recognized type, 'client' is used.

## Response `200`

Ok

## Other responses

- `400`: Bad Request
- `401`: Not Authorized
- `500`: Internal Server Error

## Changes

- **2026-11-03** `475f167d1874`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/morningstar/apis/byallaccounts-api-07302024/changes/credentials/:credentialId/authenticate/post.md)

---

[API](https://skmtc.dev/morningstar/apis/byallaccounts-api-07302024.md) - [All operations](https://skmtc.dev/morningstar/apis/byallaccounts-api-07302024/llms.txt) - [OpenAPI document](https://skmtc.dev/morningstar/apis/byallaccounts-api-07302024/revisions/475f167d1874?raw)
