Annual Review Item | Partner Developer Platform

const url = 'https://demo-d.tradovateapi.com/v1/annualReview/item?id=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "userId": 1,
  "riskDisclosureNeeded": true,
  "archived": true,
  "status": "Closed",
  "id": 1,
  "firstEmail": "string",
  "secondEmail": "string",
  "jointFirstEmail": "string",
  "jointSecondEmail": "string",
  "firstEmailSent": "2024-01-15T09:30:00Z",
  "secondEmailSent": "2024-01-15T09:30:00Z",
  "finished": "2024-01-15T09:30:00Z",
  "jointFinished": "2024-01-15T09:30:00Z",
  "identityCheckResult": "Fail",
  "jointIdentityCheckResult": "Fail",
  "contactInfoId": 1
}

Fetches AnnualReview entity by id field

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idlongRequired

Response

AnnualReview

userIdlong

riskDisclosureNeededboolean

archivedboolean

statusenum

Closed, Open, Processed

idlongOptional

firstEmailstringOptional<=8192 characters

secondEmailstringOptional<=8192 characters

jointFirstEmailstringOptional<=8192 characters

jointSecondEmailstringOptional<=8192 characters

firstEmailSentdatetimeOptional

secondEmailSentdatetimeOptional

finisheddatetimeOptional

jointFinisheddatetimeOptional

identityCheckResultenumOptional

Fail, Pass, ReviewNeeded

jointIdentityCheckResultenumOptional

Fail, Pass, ReviewNeeded

contactInfoIdlongOptional