Annual Review Item

GET

https://demo-d.tradovateapi.com/v1/annualReview/item

GET

/v1/annualReview/item

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

200Retrieved

1 {
2   "userId": 1,
3   "riskDisclosureNeeded": true,
4   "archived": true,
5   "status": "Closed",
6   "id": 1,
7   "firstEmail": "string",
8   "secondEmail": "string",
9   "jointFirstEmail": "string",
10   "jointSecondEmail": "string",
11   "firstEmailSent": "2024-01-15T09:30:00Z",
12   "secondEmailSent": "2024-01-15T09:30:00Z",
13   "finished": "2024-01-15T09:30:00Z",
14   "jointFinished": "2024-01-15T09:30:00Z",
15   "identityCheckResult": "Fail",
16   "jointIdentityCheckResult": "Fail",
17   "contactInfoId": 1
18 }

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

Allowed values:

idlong

firstEmailstring<=8192 characters

secondEmailstring<=8192 characters

jointFirstEmailstring<=8192 characters

jointSecondEmailstring<=8192 characters

firstEmailSentdatetime

secondEmailSentdatetime

finisheddatetime

jointFinisheddatetime

identityCheckResultenum

Fail, Pass, ReviewNeeded

Allowed values:

jointIdentityCheckResultenum

Fail, Pass, ReviewNeeded

Allowed values:

contactInfoIdlong