Annual Review Items

GET

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

GET

/v1/annualReview/items

1 const url = 'https://demo-d.tradovateapi.com/v1/annualReview/items?ids=%5B1%5D';
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   {
3     "userId": 1,
4     "riskDisclosureNeeded": true,
5     "archived": true,
6     "status": "Closed",
7     "id": 1,
8     "firstEmail": "string",
9     "secondEmail": "string",
10     "jointFirstEmail": "string",
11     "jointSecondEmail": "string",
12     "firstEmailSent": "2024-01-15T09:30:00Z",
13     "secondEmailSent": "2024-01-15T09:30:00Z",
14     "finished": "2024-01-15T09:30:00Z",
15     "jointFinished": "2024-01-15T09:30:00Z",
16     "identityCheckResult": "Fail",
17     "jointIdentityCheckResult": "Fail",
18     "contactInfoId": 1
19   }
20 ]

Fetches multiple AnnualReview entities of id field

Authentication

AuthorizationBearer

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

Query parameters

idslist of longsRequired

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