ROLE API BASIC ROLE API ROLE USER

Authentication

Main operations to authenticate a user

/auth/authenticate post

post

Authenticate a user

Secured by JWT_PLATFORM

Authentication token

Body

Media type: application/json

Type: object

Properties

username: required (string)
document: required (string)
password: required (string)

Example:

ValidRequest:

    {
    "username": "test@indexacapital.com",
    "document": "84326920L",
    "password": "T0n9ghtW3D9n3)nH3ll"
    }

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

token: required (string)

Example:

    {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c"
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

HTTP status code 423

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/auth/refresh-token get

get

Retrieve a new token for the same user

Secured by JWT

Authentication token

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

token: required (string)

Example:

    {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c"
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Example:

Invalid_User_Token:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Questionnaire

/questions/{product}/calculate-risk post

post

Calculate the risk level for person that answer the questions

Secured by JWT_PLATFORM

Authentication token

URI Parameters

product: required (string)

Body

Media type: application/json

Type: object

Properties

goal: required (one of 1, 2, 3, 4)
Yearly expected return of the investition. Values:
- '1': 1-2% Protection against inflation and wealth stability
- '2': 3-4% Balance between stability and wealth growth
- '3': 4-5% Wealth growth assuming a higher level of risk
- '4': Maximum profitability, regardless of risk
attitude: required (one of 1, 2, 3, 4)
The global stock market is often volatile. Imagine that your investment portfolio loses 10% of its value in a month, what would you do?
- '1': Sell everything
- '2': Sell something
- '3': Maintain
- '4': Buy more
risk: required (one of 1, 2, 3, 4)
If you think of the word "risk", which of the following words comes to mind?
- '1': Loss
- '2': Uncertainty
- '3': Opportunity
- '4': Emotion
experience: required (one of 0, 1)
In the past, have you invested in stocks or mutual funds?
- 1: Yes
- 0: No, although I know the risks associated
age: required (number - minimum: 0 - maximum: 99)
How old are the user answering questions
wealth: required (number - minimum: 50)
What is the amount of your investments in liquid assets? (For example current accounts, deposits, mutual funds, shares ...)
income: required (number - minimum: 0)
What is your annual income after taxes?
stability: required (one of 1, 2, 3, 4 - minimum: 0)
How stable is your current and future income? (Eg salary, pension, income)
- 1 = Very stable (certainly not reduced)
- 2 = Stable
- 3 = Unstable
- 4 = Very unstable
expenses: required (one of 25, 50, 75, 100)
What percentage of your income goes in expenses? (Eg mortgage, education, car, food)
- 25 = Less than 25%
- 50 = Between 25% and 50%
- 75 = Between 50% and 75%
- 100 = More than 75%
horizon: (one of 1, 2, 5, 10, 100)
What is your investment horizon? (Only required for mutual plans)
- 1 = Less than a year
- 2 = Less than two years
- 5 = Less than five years
- 10 = Less than ten years
- 100 = More than ten years

Examples:

Mutual:

    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    }

Pension:

    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000
    }

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

tolerance: required (number - minimum: 1 - maximum: 10)
capacity: required (number - minimum: 1 - maximum: 10)
total: required (number - minimum: 1 - maximum: 10)

Examples:

Max:

    {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    }

Middle:

    {
    "tolerance": 8,
    "capacity": 7,
    "total": 7
    }

Min:

    {
    "tolerance": 1,
    "capacity": 1,
    "total": 1
    }

HTTP status code 400

Body

Media type: application/json

Type: object

Properties

code: required (number)
message: required (string)
errors: required (object)
- errors: (array of )
- children: required (object)

Examples:

Bad_Goal_Value:

    {
    "code": 400,
    "message": "Validation Failed",
    "errors": {
    "errors": [],
    "children": {
    "goal": [
    "Este valor debería ser 4 o menos."
    ],
    "attitude": {},
    "risk": {},
    "experience": {},
    "age": {},
    "wealth": {},
    "income": {},
    "stability": {},
    "expenses": {},
    "investment": {},
    "horizon": {}
    }
    }
    }

Extra_Field_Pension:

    {
    "code": 400,
    "message": "Validation Failed",
    "errors": {
    "errors": [
    "Este formulario no debería contener campos adicionales."
    ],
    "children": {
    "goal": {},
    "attitude": {},
    "risk": {},
    "experience": {},
    "age": {},
    "wealth": {},
    "income": {},
    "stability": {},
    "expenses": {},
    "investment": {}
    }
    }
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Profile

/profiles post

post

Create a profile based on a risk level

Secured by JWT_PLATFORM

Authentication token

Secured by JWT

Authentication token

Body

Media type: application/json

Type: object

Properties

type: required (one of mutual, pension)
provider: required ("INV" for mutual, "CAS" for pension)
investment: required (number - minimum: 50)
risk: required (number - minimum: 1 - maximum: 10)
investment: required (number - minimum: 50)
periodic_investment: (number)
answers: required (object)
- goal: required (one of 1, 2, 3, 4)
  Yearly expected return of the investition. Values:
  - '1': 1-2% Protection against inflation and wealth stability
  - '2': 3-4% Balance between stability and wealth growth
  - '3': 4-5% Wealth growth assuming a higher level of risk
  - '4': Maximum profitability, regardless of risk
- attitude: required (one of 1, 2, 3, 4)
  The global stock market is often volatile. Imagine that your investment portfolio loses 10% of its value in a month, what would you do?
  - '1': Sell everything
  - '2': Sell something
  - '3': Maintain
  - '4': Buy more
- risk: required (one of 1, 2, 3, 4)
  If you think of the word "risk", which of the following words comes to mind?
  - '1': Loss
  - '2': Uncertainty
  - '3': Opportunity
  - '4': Emotion
- experience: required (one of 0, 1)
  In the past, have you invested in stocks or mutual funds?
  - 1: Yes
  - 0: No, although I know the risks associated
- age: required (number - minimum: 0 - maximum: 99)
  How old are the user answering questions
- wealth: required (number - minimum: 50)
  What is the amount of your investments in liquid assets? (For example current accounts, deposits, mutual funds, shares ...)
- income: required (number - minimum: 0)
  What is your annual income after taxes?
- stability: required (one of 1, 2, 3, 4 - minimum: 0)
  How stable is your current and future income? (Eg salary, pension, income)
  - 1 = Very stable (certainly not reduced)
  - 2 = Stable
  - 3 = Unstable
  - 4 = Very unstable
- expenses: required (one of 25, 50, 75, 100)
  What percentage of your income goes in expenses? (Eg mortgage, education, car, food)
  - 25 = Less than 25%
  - 50 = Between 25% and 50%
  - 75 = Between 50% and 75%
  - 100 = More than 75%
- horizon: (one of 1, 2, 5, 10, 100)
  What is your investment horizon? (Only required for mutual plans)
  - 1 = Less than a year
  - 2 = Less than two years
  - 5 = Less than five years
  - 10 = Less than ten years
  - 100 = More than ten years
Examples:
Mutual:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    }
    
```
Pension:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000
    }
    
```

Example:

Mutual:

    {
    "type": "mutual",
    "risk": 10,
    "investment": 10000,
    "answers": {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "age": 33,
    "wealth": 10000,
    "income": 100000,
    "expenses": 25,
    "stability": 1,
    "horizon": 100
    }
    }

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

answers: required (object)
- goal: required (one of 1, 2, 3, 4)
  Yearly expected return of the investition. Values:
  - '1': 1-2% Protection against inflation and wealth stability
  - '2': 3-4% Balance between stability and wealth growth
  - '3': 4-5% Wealth growth assuming a higher level of risk
  - '4': Maximum profitability, regardless of risk
- attitude: required (one of 1, 2, 3, 4)
  The global stock market is often volatile. Imagine that your investment portfolio loses 10% of its value in a month, what would you do?
  - '1': Sell everything
  - '2': Sell something
  - '3': Maintain
  - '4': Buy more
- risk: required (one of 1, 2, 3, 4)
  If you think of the word "risk", which of the following words comes to mind?
  - '1': Loss
  - '2': Uncertainty
  - '3': Opportunity
  - '4': Emotion
- experience: required (one of 0, 1)
  In the past, have you invested in stocks or mutual funds?
  - 1: Yes
  - 0: No, although I know the risks associated
- age: required (number - minimum: 0 - maximum: 99)
  How old are the user answering questions
- wealth: required (number - minimum: 50)
  What is the amount of your investments in liquid assets? (For example current accounts, deposits, mutual funds, shares ...)
- income: required (number - minimum: 0)
  What is your annual income after taxes?
- stability: required (one of 1, 2, 3, 4 - minimum: 0)
  How stable is your current and future income? (Eg salary, pension, income)
  - 1 = Very stable (certainly not reduced)
  - 2 = Stable
  - 3 = Unstable
  - 4 = Very unstable
- expenses: required (one of 25, 50, 75, 100)
  What percentage of your income goes in expenses? (Eg mortgage, education, car, food)
  - 25 = Less than 25%
  - 50 = Between 25% and 50%
  - 75 = Between 50% and 75%
  - 100 = More than 75%
- horizon: (one of 1, 2, 5, 10, 100)
  What is your investment horizon? (Only required for mutual plans)
  - 1 = Less than a year
  - 2 = Less than two years
  - 5 = Less than five years
  - 10 = Less than ten years
  - 100 = More than ten years
Examples:
Mutual:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    }
    
```
Pension:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000
    }
    
```
document: (string)
id: required (string)
GUID format
investment: required (number - minimum: 50)
is_outdated: required (boolean)
risk: required (object)
Total value never can be greather then tolerance and capacity
- tolerance: required (number - minimum: 1 - maximum: 10)
- capacity: required (number - minimum: 1 - maximum: 10)
- total: required (number - minimum: 1 - maximum: 10)
Examples:
Max:
```
    {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    }
    
```
Middle:
```
    {
    "tolerance": 8,
    "capacity": 7,
    "total": 7
    }
    
```
Min:
```
    {
    "tolerance": 1,
    "capacity": 1,
    "total": 1
    }
    
```
selected_risk: required (number - minimum: 1 - maximum: 10)
needs_to_be_updated: required (boolean)
type: required (one of mutual, pension)

Example:

    {
    "answers": {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    },
    "document": "",
    "id": "23f794f5-51c0-4778-98bc-9b5b16217425",
    "investment": 10000,
    "is_outdated": false,
    "risk": {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    },
    "selected_risk": 10,
    "type": "pension",
    "needs_to_be_updated": false
    }

HTTP status code 400

Body

Media type: application/json

Type: object

Properties

code: required (number)
message: required (string)
errors: required (object)
- errors: (array of )
- children: required (object)

Examples:

Extra_Fields:

    {
    "code": 400,
    "message": "Validation Failed",
    "errors": {
    "errors": [
    "Este formulario no debería contener campos adicionales."
    ],
    "children": {
    "goal": {},
    "attitude": {},
    "risk": {},
    "experience": {},
    "age": {},
    "wealth": {},
    "income": {},
    "stability": {},
    "expenses": {},
    "investment": {}
    }
    }
    }

Invalid_Values:

    {
    "code": 400,
    "message": "Validation Failed",
    "errors": {
    "children": {
    "goal": {
    "errors": [
    "Este valor debería ser 4 o menos."
    ]
    },
    "attitude": {},
    "risk": {},
    "experience": {},
    "age": {},
    "wealth": {},
    "income": {},
    "stability": {},
    "expenses": {},
    "investment": {}
    }
    }
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/profiles/{id} get post

get

Get profile information for the id

post

Update the profile with new data

Get profile information for the id

Secured by JWT

Authentication token

URI Parameters

id: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

answers: required (object)
- goal: required (one of 1, 2, 3, 4)
  Yearly expected return of the investition. Values:
  - '1': 1-2% Protection against inflation and wealth stability
  - '2': 3-4% Balance between stability and wealth growth
  - '3': 4-5% Wealth growth assuming a higher level of risk
  - '4': Maximum profitability, regardless of risk
- attitude: required (one of 1, 2, 3, 4)
  The global stock market is often volatile. Imagine that your investment portfolio loses 10% of its value in a month, what would you do?
  - '1': Sell everything
  - '2': Sell something
  - '3': Maintain
  - '4': Buy more
- risk: required (one of 1, 2, 3, 4)
  If you think of the word "risk", which of the following words comes to mind?
  - '1': Loss
  - '2': Uncertainty
  - '3': Opportunity
  - '4': Emotion
- experience: required (one of 0, 1)
  In the past, have you invested in stocks or mutual funds?
  - 1: Yes
  - 0: No, although I know the risks associated
- age: required (number - minimum: 0 - maximum: 99)
  How old are the user answering questions
- wealth: required (number - minimum: 50)
  What is the amount of your investments in liquid assets? (For example current accounts, deposits, mutual funds, shares ...)
- income: required (number - minimum: 0)
  What is your annual income after taxes?
- stability: required (one of 1, 2, 3, 4 - minimum: 0)
  How stable is your current and future income? (Eg salary, pension, income)
  - 1 = Very stable (certainly not reduced)
  - 2 = Stable
  - 3 = Unstable
  - 4 = Very unstable
- expenses: required (one of 25, 50, 75, 100)
  What percentage of your income goes in expenses? (Eg mortgage, education, car, food)
  - 25 = Less than 25%
  - 50 = Between 25% and 50%
  - 75 = Between 50% and 75%
  - 100 = More than 75%
- horizon: (one of 1, 2, 5, 10, 100)
  What is your investment horizon? (Only required for mutual plans)
  - 1 = Less than a year
  - 2 = Less than two years
  - 5 = Less than five years
  - 10 = Less than ten years
  - 100 = More than ten years
Examples:
Mutual:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    }
    
```
Pension:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000
    }
    
```
document: (string)
id: required (string)
GUID format
investment: required (number - minimum: 50)
is_outdated: required (boolean)
risk: required (object)
Total value never can be greather then tolerance and capacity
- tolerance: required (number - minimum: 1 - maximum: 10)
- capacity: required (number - minimum: 1 - maximum: 10)
- total: required (number - minimum: 1 - maximum: 10)
Examples:
Max:
```
    {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    }
    
```
Middle:
```
    {
    "tolerance": 8,
    "capacity": 7,
    "total": 7
    }
    
```
Min:
```
    {
    "tolerance": 1,
    "capacity": 1,
    "total": 1
    }
    
```
selected_risk: required (number - minimum: 1 - maximum: 10)
needs_to_be_updated: required (boolean)
type: required (one of mutual, pension)

Example:

    {
    "answers": {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    },
    "document": "",
    "id": "23f794f5-51c0-4778-98bc-9b5b16217425",
    "investment": 10000,
    "is_outdated": false,
    "risk": {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    },
    "selected_risk": 10,
    "type": "pension",
    "needs_to_be_updated": false
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

HTTP status code 404

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Update the profile with new data

Secured by JWT

Authentication token

URI Parameters

id: required (string)

Body

Media type: application/json

Type: object

Properties

answers: (object)
- goal: required (one of 1, 2, 3, 4)
  Yearly expected return of the investition. Values:
  - '1': 1-2% Protection against inflation and wealth stability
  - '2': 3-4% Balance between stability and wealth growth
  - '3': 4-5% Wealth growth assuming a higher level of risk
  - '4': Maximum profitability, regardless of risk
- attitude: required (one of 1, 2, 3, 4)
  The global stock market is often volatile. Imagine that your investment portfolio loses 10% of its value in a month, what would you do?
  - '1': Sell everything
  - '2': Sell something
  - '3': Maintain
  - '4': Buy more
- risk: required (one of 1, 2, 3, 4)
  If you think of the word "risk", which of the following words comes to mind?
  - '1': Loss
  - '2': Uncertainty
  - '3': Opportunity
  - '4': Emotion
- experience: required (one of 0, 1)
  In the past, have you invested in stocks or mutual funds?
  - 1: Yes
  - 0: No, although I know the risks associated
- age: required (number - minimum: 0 - maximum: 99)
  How old are the user answering questions
- wealth: required (number - minimum: 50)
  What is the amount of your investments in liquid assets? (For example current accounts, deposits, mutual funds, shares ...)
- income: required (number - minimum: 0)
  What is your annual income after taxes?
- stability: required (one of 1, 2, 3, 4 - minimum: 0)
  How stable is your current and future income? (Eg salary, pension, income)
  - 1 = Very stable (certainly not reduced)
  - 2 = Stable
  - 3 = Unstable
  - 4 = Very unstable
- expenses: required (one of 25, 50, 75, 100)
  What percentage of your income goes in expenses? (Eg mortgage, education, car, food)
  - 25 = Less than 25%
  - 50 = Between 25% and 50%
  - 75 = Between 50% and 75%
  - 100 = More than 75%
- horizon: (one of 1, 2, 5, 10, 100)
  What is your investment horizon? (Only required for mutual plans)
  - 1 = Less than a year
  - 2 = Less than two years
  - 5 = Less than five years
  - 10 = Less than ten years
  - 100 = More than ten years
Examples:
Mutual:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    }
    
```
Pension:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000
    }
    
```
risk: (number - minimum: 1 - maximum: 10)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

answers: required (object)
- goal: required (one of 1, 2, 3, 4)
  Yearly expected return of the investition. Values:
  - '1': 1-2% Protection against inflation and wealth stability
  - '2': 3-4% Balance between stability and wealth growth
  - '3': 4-5% Wealth growth assuming a higher level of risk
  - '4': Maximum profitability, regardless of risk
- attitude: required (one of 1, 2, 3, 4)
  The global stock market is often volatile. Imagine that your investment portfolio loses 10% of its value in a month, what would you do?
  - '1': Sell everything
  - '2': Sell something
  - '3': Maintain
  - '4': Buy more
- risk: required (one of 1, 2, 3, 4)
  If you think of the word "risk", which of the following words comes to mind?
  - '1': Loss
  - '2': Uncertainty
  - '3': Opportunity
  - '4': Emotion
- experience: required (one of 0, 1)
  In the past, have you invested in stocks or mutual funds?
  - 1: Yes
  - 0: No, although I know the risks associated
- age: required (number - minimum: 0 - maximum: 99)
  How old are the user answering questions
- wealth: required (number - minimum: 50)
  What is the amount of your investments in liquid assets? (For example current accounts, deposits, mutual funds, shares ...)
- income: required (number - minimum: 0)
  What is your annual income after taxes?
- stability: required (one of 1, 2, 3, 4 - minimum: 0)
  How stable is your current and future income? (Eg salary, pension, income)
  - 1 = Very stable (certainly not reduced)
  - 2 = Stable
  - 3 = Unstable
  - 4 = Very unstable
- expenses: required (one of 25, 50, 75, 100)
  What percentage of your income goes in expenses? (Eg mortgage, education, car, food)
  - 25 = Less than 25%
  - 50 = Between 25% and 50%
  - 75 = Between 50% and 75%
  - 100 = More than 75%
- horizon: (one of 1, 2, 5, 10, 100)
  What is your investment horizon? (Only required for mutual plans)
  - 1 = Less than a year
  - 2 = Less than two years
  - 5 = Less than five years
  - 10 = Less than ten years
  - 100 = More than ten years
Examples:
Mutual:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    }
    
```
Pension:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000
    }
    
```
document: (string)
id: required (string)
GUID format
investment: required (number - minimum: 50)
is_outdated: required (boolean)
risk: required (object)
Total value never can be greather then tolerance and capacity
- tolerance: required (number - minimum: 1 - maximum: 10)
- capacity: required (number - minimum: 1 - maximum: 10)
- total: required (number - minimum: 1 - maximum: 10)
Examples:
Max:
```
    {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    }
    
```
Middle:
```
    {
    "tolerance": 8,
    "capacity": 7,
    "total": 7
    }
    
```
Min:
```
    {
    "tolerance": 1,
    "capacity": 1,
    "total": 1
    }
    
```
selected_risk: required (number - minimum: 1 - maximum: 10)
needs_to_be_updated: required (boolean)
type: required (one of mutual, pension)

Example:

    {
    "answers": {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    },
    "document": "",
    "id": "23f794f5-51c0-4778-98bc-9b5b16217425",
    "investment": 10000,
    "is_outdated": false,
    "risk": {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    },
    "selected_risk": 10,
    "type": "pension",
    "needs_to_be_updated": false
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

HTTP status code 404

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/profiles/{id}/open-account post

post

Open a new account for the current user based on given profile

Secured by JWT_PLATFORM

Authentication token

URI Parameters

id: required (string)

Body

Media type: application/json

Type: object

Properties

email: required (string - pattern: ^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$)

HTTP status code 200

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Users

/users post

post

Create a new user

Secured by JWT_PLATFORM

Authentication token

Body

Media type: application/json

Type: object

Properties

email: required (string - pattern: ^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$)
phone: required (string - pattern: ^\+34([6-7]\d{2})(\d{3})(\d{3})$)
document: required (object)
- type: required (string)
  One of (nif, cif, pass, nie, doc_ext, cif_no_r, nif_no_r, nif_meno)
- number: required (string - pattern: ^\d{8}\w$)
password: required (string - pattern: ^.*(?=.{8,})(?=.*[a-zA-Z])(?=.*\d).*$)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

username: required (string - pattern: ^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$)
email: required (string - pattern: ^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$)
name: (string)
surname: (string)
phone: required (string - pattern: ^\+34([6-7]\d{2})(\d{3})(\d{3})$)
document_type: required (one of nif, cif, pass, nie, doc_ext, cif_no_r, nif_no_r, nif_meno)
document: required (string - pattern: ^\d{8}\w$)
roles: required (array of items)
is_activated: required (boolean)
phone_activated: required (boolean)
email_activated: required (boolean)
source: (string)
affiliate_fee: required (number)
profiles: (array of )
GUID format
accounts: (array of items)
Items: items
- account_number: required (string)
- status: required (string)
- type: required (one of mutual, pension)
- @path: required (string)
accounts_relations: (array of items)
Items: items
- account_number: required (string)
- relation: required (one of owner, auth, guest)
person: (object)
- name: required (string)

Examples:

Pending_Activation:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": false,
    "phone_activated": false,
    "email_activated": false,
    "affiliate_fee": 0
    }

Pending_Phone_Activation:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": false,
    "phone_activated": false,
    "email_activated": true,
    "affiliate_fee": 0
    }

Active_User:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": true,
    "phone_activated": true,
    "email_activated": true,
    "affiliate_fee": 0
    }

User_With_Profile_Without_Account:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": true,
    "phone_activated": true,
    "email_activated": true,
    "affiliate_fee": 0,
    "profiles": [
    "e5cfe6e9-d40e-4211-96b9-45c1cd78a958"
    ]
    }

Full_User:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": true,
    "phone_activated": true,
    "email_activated": true,
    "affiliate_fee": 0,
    "accounts_relations": [
    {
    "account_number": "PBKLBYZ5",
    "relation": "owner"
    },
    {
    "account_number": "PBKRBYY1",
    "relation": "owner"
    }
    ],
    "accounts": [
    {
    "account_number": "PBKRBYY1",
    "status": "active",
    "type": "pension",
    "@path": "/accounts/PBKRBYY1"
    },
    {
    "account_number": "PBKLBYZ5",
    "status": "active",
    "type": "mutual",
    "@path": "/accounts/PBKLBYZ5"
    }
    ]
    }

HTTP status code 400

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

HTTP status code 404

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/users/me get

get

Retrieve data of authenticated user

Secured by JWT

Authentication token

Headers

Accept: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

username: required (string - pattern: ^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$)
email: required (string - pattern: ^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$)
name: (string)
surname: (string)
phone: required (string - pattern: ^\+34([6-7]\d{2})(\d{3})(\d{3})$)
document_type: required (one of nif, cif, pass, nie, doc_ext, cif_no_r, nif_no_r, nif_meno)
document: required (string - pattern: ^\d{8}\w$)
roles: required (array of items)
is_activated: required (boolean)
phone_activated: required (boolean)
email_activated: required (boolean)
source: (string)
affiliate_fee: required (number)
profiles: (array of )
GUID format
accounts: (array of items)
Items: items
- account_number: required (string)
- status: required (string)
- type: required (one of mutual, pension)
- @path: required (string)
accounts_relations: (array of items)
Items: items
- account_number: required (string)
- relation: required (one of owner, auth, guest)
person: (object)
- name: required (string)

Examples:

Pending_Activation:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": false,
    "phone_activated": false,
    "email_activated": false,
    "affiliate_fee": 0
    }

Pending_Phone_Activation:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": false,
    "phone_activated": false,
    "email_activated": true,
    "affiliate_fee": 0
    }

Active_User:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": true,
    "phone_activated": true,
    "email_activated": true,
    "affiliate_fee": 0
    }

User_With_Profile_Without_Account:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": true,
    "phone_activated": true,
    "email_activated": true,
    "affiliate_fee": 0,
    "profiles": [
    "e5cfe6e9-d40e-4211-96b9-45c1cd78a958"
    ]
    }

Full_User:

    {
    "username": "asdasd@adad.com",
    "roles": [
    "ROLE_USER"
    ],
    "email": "asdasd@adad.com",
    "phone": "+34678987123",
    "document": "78196523L",
    "document_type": "nif",
    "is_activated": true,
    "phone_activated": true,
    "email_activated": true,
    "affiliate_fee": 0,
    "accounts_relations": [
    {
    "account_number": "PBKLBYZ5",
    "relation": "owner"
    },
    {
    "account_number": "PBKRBYY1",
    "relation": "owner"
    }
    ],
    "accounts": [
    {
    "account_number": "PBKRBYY1",
    "status": "active",
    "type": "pension",
    "@path": "/accounts/PBKRBYY1"
    },
    {
    "account_number": "PBKLBYZ5",
    "status": "active",
    "type": "mutual",
    "@path": "/accounts/PBKLBYZ5"
    }
    ]
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Accounts

/accounts/{account_number} get

get

Retrieve basic account info

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

account_number: required (string)
account_type: (one of personal, company, minor)
funding: required (one of total, partial, no)
profile: required (object)
- answers: required (object)
  - goal: required (one of 1, 2, 3, 4)
    Yearly expected return of the investition. Values:
    - '1': 1-2% Protection against inflation and wealth stability
    - '2': 3-4% Balance between stability and wealth growth
    - '3': 4-5% Wealth growth assuming a higher level of risk
    - '4': Maximum profitability, regardless of risk
  - attitude: required (one of 1, 2, 3, 4)
    The global stock market is often volatile. Imagine that your investment portfolio loses 10% of its value in a month, what would you do?
    - '1': Sell everything
    - '2': Sell something
    - '3': Maintain
    - '4': Buy more
  - risk: required (one of 1, 2, 3, 4)
    If you think of the word "risk", which of the following words comes to mind?
    - '1': Loss
    - '2': Uncertainty
    - '3': Opportunity
    - '4': Emotion
  - experience: required (one of 0, 1)
    In the past, have you invested in stocks or mutual funds?
    - 1: Yes
    - 0: No, although I know the risks associated
  - age: required (number - minimum: 0 - maximum: 99)
    How old are the user answering questions
  - wealth: required (number - minimum: 50)
    What is the amount of your investments in liquid assets? (For example current accounts, deposits, mutual funds, shares ...)
  - income: required (number - minimum: 0)
    What is your annual income after taxes?
  - stability: required (one of 1, 2, 3, 4 - minimum: 0)
    How stable is your current and future income? (Eg salary, pension, income)
    - 1 = Very stable (certainly not reduced)
    - 2 = Stable
    - 3 = Unstable
    - 4 = Very unstable
  - expenses: required (one of 25, 50, 75, 100)
    What percentage of your income goes in expenses? (Eg mortgage, education, car, food)
    - 25 = Less than 25%
    - 50 = Between 25% and 50%
    - 75 = Between 50% and 75%
    - 100 = More than 75%
  - horizon: (one of 1, 2, 5, 10, 100)
    What is your investment horizon? (Only required for mutual plans)
    - 1 = Less than a year
    - 2 = Less than two years
    - 5 = Less than five years
    - 10 = Less than ten years
    - 100 = More than ten years
  Examples:
  Mutual:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    }
    
```
  Pension:
```
    {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000
    }
    
```
- document: (string)
- id: required (string)
  GUID format
- investment: required (number - minimum: 50)
- is_outdated: required (boolean)
- risk: required (object)
  Total value never can be greather then tolerance and capacity
  - tolerance: required (number - minimum: 1 - maximum: 10)
  - capacity: required (number - minimum: 1 - maximum: 10)
  - total: required (number - minimum: 1 - maximum: 10)
  Examples:
  Max:
```
    {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    }
    
```
  Middle:
```
    {
    "tolerance": 8,
    "capacity": 7,
    "total": 7
    }
    
```
  Min:
```
    {
    "tolerance": 1,
    "capacity": 1,
    "total": 1
    }
    
```
- selected_risk: required (number - minimum: 1 - maximum: 10)
- needs_to_be_updated: required (boolean)
- type: required (one of mutual, pension)
Example:
```
    {
    "answers": {
    "goal": 4,
    "attitude": 4,
    "risk": 4,
    "experience": 1,
    "income": 100000,
    "age": 33,
    "stability": 1,
    "expenses": 25,
    "wealth": 10000,
    "horizon": 100
    },
    "document": "",
    "id": "23f794f5-51c0-4778-98bc-9b5b16217425",
    "investment": 10000,
    "is_outdated": false,
    "risk": {
    "tolerance": 10,
    "capacity": 10,
    "total": 10
    },
    "selected_risk": 10,
    "type": "pension",
    "needs_to_be_updated": false
    }
    
```
size: required (one of small, medium, large)
currency: required (string)
status: required (one of init, awaiting, init-failed, pending-contract, pending-pbc, pending-provider, active, inactive, cancelled, cancel-request, deleted)
type: required (one of mutual, pension)
holders: (array of Holder)
Items: Holder
- date: required (string - pattern: \d{4}\\\d{2}\\\d{2}\ \d{2}:\d{2}:\d{2})
- address: required (object)
  - street_type: required (one of AC, AD, AL, AP, AT, AV, BL, BO, CH, CL, CM, CO, CR, CS, CT, ED, GL, GR, LG, MC, MN, MZ, PB, PG, PJ, PQ, PR, PS, PZ, RB, RD, TR, UR)
  - street_name: required (string)
  - street_number: required (string)
  - street_extra: (string)
  - postal_code: required (string - pattern: /d{3,5})
  - city: required (string)
  - state: required (integer)
  - country: required (integer)
- document_type: (string)
- document_type_code: required (one of nif, cif, pass, nie, doc_ext, cif_no_r, nif_no_r, nif_meno)
- document: required (string - pattern: ^\d{8}\w$)
- double_address: required (boolean)
- full_name: required (string)
- gender: required (one of H, M)
- marital_status: required (one of C, S, O)
- earning_type: required (one of GA, PA, SB, LE)
- name: required (string)
- surname: required (string)
- surname2: (string)
- person_type: required (one of natural, legal)
- phone: (string)
- type: required (one of BEN, MAIN)
- percentage: (number - minimum: 1 - maximum: 100)
- participation_level: (number - minimum: 1 - maximum: 100)
- documents: (array of Document)
  Items: Document
  - id: required (integer)
  - type: required (string)
  - name: required (string)
  - originalName: required (string)
  - original_name: required (string)
  - showName: required (string)
  - show_name: required (string)
  - created_at: required (string - pattern: \d{4}\\\d{2}\\\d{2}\ \d{2}:\d{2}:\d{2})
  - signed: required (boolean)
  - path: required (string)
platform_code: required (string)
preferences: (array of items)

HTTP status code 400

Body

Media type: application/json

Type: object

Properties

code: required (number)
message: required (string)
errors: required (object)
- errors: (array of )
- children: required (object)

Examples:

Extra_Fields:

    {
    "code": 400,
    "message": "Validation Failed",
    "errors": {
    "errors": [
    "Este formulario no debería contener campos adicionales."
    ],
    "children": {
    "goal": {},
    "attitude": {},
    "risk": {},
    "experience": {},
    "age": {},
    "wealth": {},
    "income": {},
    "stability": {},
    "expenses": {},
    "investment": {}
    }
    }
    }

Invalid_Values:

    {
    "code": 400,
    "message": "Validation Failed",
    "errors": {
    "children": {
    "goal": {
    "errors": [
    "Este valor debería ser 4 o menos."
    ]
    },
    "attitude": {},
    "risk": {},
    "experience": {},
    "age": {},
    "wealth": {},
    "income": {},
    "stability": {},
    "expenses": {},
    "investment": {}
    }
    }
    }

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/holders post

post

Add new holder to the given account

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

Body

Media type: application/json

Type: object

Properties

person: required (object)
- info: required (object)
  - name: required (string)
  - surname: required (string)
  - surname2: (string)
  - document: required (object)
    - type: required (one of nif, cif, pass, nie, doc_ext, cif_no_r, nif_no_r, nif_meno)
    - number: required (string - pattern: ^\d{8}\w$)
  - birthdate: required (string - pattern: \d{4}\\\d{2}\\\d{2})
  - city_nationality: required (string)
    City name where the person has been born
  - nationality: required (integer)
    Country id
  - gender: required (one of H, M)
  - marital_status: required (one of C, S, O)
  - earning_type: (one of GA, PA, SB, LE)
    Required for married people
  - email: required (string - pattern: ^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$)
  - mobile: required (string - pattern: ^\+34([6-7]\d{2})(\d{3})(\d{3})$)
  - fiscal_address: required (object)
    - street_type: required (one of AC, AD, AL, AP, AT, AV, BL, BO, CH, CL, CM, CO, CR, CS, CT, ED, GL, GR, LG, MC, MN, MZ, PB, PG, PJ, PQ, PR, PS, PZ, RB, RD, TR, UR)
    - street_name: required (string)
    - street_number: required (string)
    - street_extra: (string)
    - postal_code: required (string - pattern: /d{3,5})
    - city: required (string)
    - state: required (integer)
    - country: required (integer)
  - second_country: (integer)
    Id of the second country if has double nationality
  - second_document: (string)
    Required if has second_country
- professional_details: required (object)
  - education: required (number - minimum: 1 - maximum: 4)
  - cnae: required (number)
  - employer_name: required (string)
  - employee_position: required (string)
  - public_affairs_type: (one of politician, judge, ambassador, governor, other)
  - public_affairs_comment: (string)
- patrimony_details: required (object)
  - income_yearly: required (number)
  - income_origin: required (one of estate, fees, own-business, salary)
    Requd only for adult
  - estate: required (number)
  - estate_origin: required (integer)
  - estate_description: required (string)
estate_origin: (integer)
Required for mutual account
postal_address: required (object)
- street_type: required (one of AC, AD, AL, AP, AT, AV, BL, BO, CH, CL, CM, CO, CR, CS, CT, ED, GL, GR, LG, MC, MN, MZ, PB, PG, PJ, PQ, PR, PS, PZ, RB, RD, TR, UR)
- street_name: required (string)
- street_number: required (string)
- street_extra: (string)
- postal_code: required (string - pattern: /d{3,5})
- city: required (string)
- state: required (integer)
- country: required (integer)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

date: required (string - pattern: \d{4}\\\d{2}\\\d{2}\ \d{2}:\d{2}:\d{2})
address: required (object)
- street_type: required (one of AC, AD, AL, AP, AT, AV, BL, BO, CH, CL, CM, CO, CR, CS, CT, ED, GL, GR, LG, MC, MN, MZ, PB, PG, PJ, PQ, PR, PS, PZ, RB, RD, TR, UR)
- street_name: required (string)
- street_number: required (string)
- street_extra: (string)
- postal_code: required (string - pattern: /d{3,5})
- city: required (string)
- state: required (integer)
- country: required (integer)
document_type: (string)
document_type_code: required (one of nif, cif, pass, nie, doc_ext, cif_no_r, nif_no_r, nif_meno)
document: required (string - pattern: ^\d{8}\w$)
double_address: required (boolean)
full_name: required (string)
gender: required (one of H, M)
marital_status: required (one of C, S, O)
earning_type: required (one of GA, PA, SB, LE)
name: required (string)
surname: required (string)
surname2: (string)
person_type: required (one of natural, legal)
phone: (string)
type: required (one of BEN, MAIN)
percentage: (number - minimum: 1 - maximum: 100)
participation_level: (number - minimum: 1 - maximum: 100)
documents: (array of Document)
Items: Document
- id: required (integer)
- type: required (string)
- name: required (string)
- originalName: required (string)
- original_name: required (string)
- showName: required (string)
- show_name: required (string)
- created_at: required (string - pattern: \d{4}\\\d{2}\\\d{2}\ \d{2}:\d{2}:\d{2})
- signed: required (boolean)
- path: required (string)

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/transfers post

post

Add transfer to account

Secured by JWT

Authentication token

Request
Security

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

Body

Media type: application/json

Type: object

Properties

from_code: required (string)
Origin instrument identifier
percentage: required (integer)
Percentage to transfer (0 < value <= 100)
external_bank_account: (string)
Origin account number. (Required only for mutual accounts)
expected_amount: (floar)
Expected amount to be transfered (default 0)
marketer_from: (string)
Origin marketer fiscal number (example: for BNP spain value must be: A28000370)

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/contributions post

post

Add contribution to account

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

Body

Media type: application/json

Type: object

Properties

amount: required (integer)
iban: required (string)
periodicity: required (one of unique, monthly, quarterly, annually)
start_date: required (string - pattern: \d{4}\\\d{2}\\\d{2})

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required (integer)
status: required (one of active, pending-orders, pending-transactions, partially-completed, completed, rejected, cancelled)
amount: required (number)
first_date: required (string - pattern: \d{4}\\\d{2}\\\d{2}\ \d{2}:\d{2}:\d{2})
next_date: required (string - pattern: \d{4}\\\d{2}\\\d{2}\ \d{2}:\d{2}:\d{2})
requested_at: required (string - pattern: \d{4}\\\d{2}\\\d{2}\ \d{2}:\d{2}:\d{2})
bank_account: required (string)

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/bank-account post

post

Add bank account for the given Indexa Account

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

Body

Media type: multipart/form-data

Type: object

Properties

iban: required (string)
outgoing: required (boolean)
True if the bank account is to withdraw cash.

HTTP status code 200

Body

Media type: application/json

Type: BankAccount

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/bank-account/{iban}/document post

post

Upload bank statement

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```
iban: required (string)

Body

Media type: multipart/form-data

Type: object

Properties

file: required (file)
type: required (one of bank_account_ownership, bank_account_signature)
name: (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required (integer)
type: required (string)
name: required (string)
originalName: required (string)
original_name: required (string)
showName: required (string)
show_name: required (string)
created_at: required (string - pattern: \d{4}\\\d{2}\\\d{2}\ \d{2}:\d{2}:\d{2})
signed: required (boolean)
path: required (string)

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/cash-requests post

post

Add new cash request

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

Body

Media type: multipart/form-data

Type: object

Properties

type: required (one of partial, total)
amount: (float)
Required only if type == partial
iban: required (string)

HTTP status code 200

Body

Media type: application/json

Type: CashRequest

HTTP status code 403

Body

Media type: application/json

Type: object

Properties

code: (one of 200, 400, 403, 404, 423, 500)
message: required (string)

Examples:

Authentication_error:

    {
    "code": 403,
    "message": "Invalid credentials."
    }

Account_locked:

    {
    "code": 423,
    "message": "Account is locked"
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/documents get

get

Retrieve a list with all documents related to the given account, and of all its holders

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

    {
    "account": [
    {
    "id": 55221,
    "type": "rep_port_month",
    "name": "asdfasdfasd882143_1488341228.pdf",
    "originalName": "",
    "original_name": "",
    "showName": "Informe mensual Indexa Capital - AABBCCDD - 2017-02",
    "show_name": "Informe mensual Indexa Capital - AABBCCDD - 2017-02",
    "created_at": "2017-03-01 05:07:08",
    "signed": false
    }
    ],
    "holder": [
    {
    "id": 26407,
    "type": "rep_profile",
    "name": "asdfasdf8d05f0ee_1477580312.pdf",
    "originalName": "",
    "original_name": "",
    "showName": "Test de idoneidad - 27/10/2016",
    "show_name": "Test de idoneidad - 27/10/2016",
    "created_at": "2016-10-27 16:58:32",
    "signed": false
    }
    ]
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/fiscal-results get

get

Retrieve a list with the current fiscal results of the account

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

    {
    "fiscal_results": [
    {
    "amount": 480.4831168,
    "account": "INDEXA05",
    "cost_amount": 435.59,
    "cost_price": 163.3270590705592,
    "date": "2017-03-07",
    "instrument": {
    "asset_class": "equity_europe",
    "asset_class_description": "equity_europe",
    "description": "Este fondo tiene como objetivo replicar el índice Standard MSCI Europe. Este objetivo se consigue mediante la inversión en una cartera de acciones. El fondo se gestiona de forma pasiva y tiene como objetivo minimizar el tracking error (diferencia entre los rendimientos de la clase de acción y los del índice de referencia). Código ISIN: LU0188800162.",
    "identifier": "LU0188800162",
    "identifier_name": "Código ISIN",
    "name": "Pictet Europe Idx -I"
    },
    "price": 180.16,
    "profit_loss": 44.89311680000003,
    "realized": false,
    "subscription_date": "2016-06-03 00:00:00",
    "titles": 2.66698
    },
    {
    "amount": 543.4704,
    "account": "INDEXA05",
    "cost_amount": 435.51432000000005,
    "cost_price": 120.9762,
    "date": "2017-03-07",
    "instrument": {
    "asset_class": "equity_emerging",
    "asset_class_description": "equity_emerging",
    "description": "Vanguard Emerging Markets Stock Index Fund es un fondo abierto constituido en Irlanda. El objetivo del fondo es el seguimiento del rendimiento del Índice Fondo MSCI Select Emerging Markets Index Stock, (índice de empresas de 18 mercados emergentes de Europa, Asia, África y America latina). Código ISIN: IE0031786142.",
    "identifier": "IE0031786142",
    "identifier_name": "Código ISIN",
    "name": "Vanguard Emrg Mk Stk Idx -Inv"
    },
    "price": 150.964,
    "profit_loss": 107.95607999999999,
    "realized": false,
    "subscription_date": "2016-06-03 00:00:00",
    "titles": 3.6
    },
    {
    "amount": 830.0995930000001,
    "account": "INDEXA05",
    "cost_amount": 692.98,
    "cost_price": 20.630544805001488,
    "date": "2017-03-07",
    "instrument": {
    "asset_class": "equity_north_america",
    "asset_class_description": "equity_north_america",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645.",
    "identifier": "IE0032126645",
    "identifier_name": "Código ISIN",
    "name": "Vanguard US 500 Stk Idx -Inst"
    },
    "price": 24.7127,
    "profit_loss": 137.11959300000012,
    "realized": false,
    "subscription_date": "2016-06-02 00:00:00",
    "titles": 33.59
    },
    {
    "amount": 414.318256,
    "account": "INDEXA05",
    "cost_amount": 415.386816,
    "cost_price": 136.6404,
    "date": "2017-03-07",
    "instrument": {
    "asset_class": "fixed_income_euro_inflation_linked",
    "asset_class_description": "fixed_income_euro_inflation_linked",
    "description": "El objetivo es proporcionar retornos consistentes con el rendimiento de el Inflation-Linked Barclays Eurozona Bond Index. El Fondo invierte en bonos ligados a la inflación, denominados en euros, contenidos en este índice. Código ISIN: IE00B04GQQ17.",
    "identifier": "IE00B04GQQ17",
    "identifier_name": "Código ISIN",
    "name": "Vanguard Euroz Inf Lk Idx -Inv"
    },
    "price": 136.2889,
    "profit_loss": -1.0685599999999909,
    "realized": false,
    "subscription_date": "2016-06-02 00:00:00",
    "titles": 3.04
    }
    ],
    "total_fiscal_results": [
    {
    "amount": 480.4831168,
    "account": "INDEXA05",
    "cost_amount": 435.59,
    "cost_price": 163.3270590705592,
    "date": "2017-03-07",
    "instrument": {
    "asset_class": "equity_europe",
    "asset_class_description": "equity_europe",
    "description": "Este fondo tiene como objetivo replicar el índice Standard MSCI Europe. Este objetivo se consigue mediante la inversión en una cartera de acciones. El fondo se gestiona de forma pasiva y tiene como objetivo minimizar el tracking error (diferencia entre los rendimientos de la clase de acción y los del índice de referencia). Código ISIN: LU0188800162.",
    "identifier": "LU0188800162",
    "identifier_name": "Código ISIN",
    "name": "Pictet Europe Idx -I"
    },
    "price": 180.16,
    "profit_loss": 44.89311680000003,
    "realized": false,
    "subscription_date": "2016-06-03 00:00:00",
    "titles": 2.66698
    },
    {
    "amount": 543.4704,
    "account": "INDEXA05",
    "cost_amount": 435.51432000000005,
    "cost_price": 120.9762,
    "date": "2017-03-07",
    "instrument": {
    "asset_class": "equity_emerging",
    "asset_class_description": "equity_emerging",
    "description": "Vanguard Emerging Markets Stock Index Fund es un fondo abierto constituido en Irlanda. El objetivo del fondo es el seguimiento del rendimiento del Índice Fondo MSCI Select Emerging Markets Index Stock, (índice de empresas de 18 mercados emergentes de Europa, Asia, África y America latina). Código ISIN: IE0031786142.",
    "identifier": "IE0031786142",
    "identifier_name": "Código ISIN",
    "name": "Vanguard Emrg Mk Stk Idx -Inv"
    },
    "price": 150.964,
    "profit_loss": 107.95607999999999,
    "realized": false,
    "subscription_date": "2016-06-03 00:00:00",
    "titles": 3.6
    },
    {
    "amount": 830.0995930000001,
    "account": "INDEXA05",
    "cost_amount": 692.98,
    "cost_price": 20.630544805001488,
    "date": "2017-03-07",
    "instrument": {
    "asset_class": "equity_north_america",
    "asset_class_description": "equity_north_america",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645.",
    "identifier": "IE0032126645",
    "identifier_name": "Código ISIN",
    "name": "Vanguard US 500 Stk Idx -Inst"
    },
    "price": 24.7127,
    "profit_loss": 137.11959300000012,
    "realized": false,
    "subscription_date": "2016-06-02 00:00:00",
    "titles": 33.59
    },
    {
    "amount": 414.318256,
    "account": "INDEXA05",
    "cost_amount": 415.386816,
    "cost_price": 136.6404,
    "date": "2017-03-07",
    "instrument": {
    "asset_class": "fixed_income_euro_inflation_linked",
    "asset_class_description": "fixed_income_euro_inflation_linked",
    "description": "El objetivo es proporcionar retornos consistentes con el rendimiento de el Inflation-Linked Barclays Eurozona Bond Index. El Fondo invierte en bonos ligados a la inflación, denominados en euros, contenidos en este índice. Código ISIN: IE00B04GQQ17.",
    "identifier": "IE00B04GQQ17",
    "identifier_name": "Código ISIN",
    "name": "Vanguard Euroz Inf Lk Idx -Inv"
    },
    "price": 136.2889,
    "profit_loss": -1.0685599999999909,
    "realized": false,
    "subscription_date": "2016-06-02 00:00:00",
    "titles": 3.04
    }
    ]
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/invoices get

get

Retrieve a list with all invoices of to the given account

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

    [
    {
    "account_number": "INDEXA01",
    "date_from": "2015-10-01",
    "date_to": "2015-12-31",
    "fees": 25.87,
    "vat": 5.43,
    "amount": 509532.11,
    "average_fee": 1.9565532019445353,
    "document": {
    "id": 580,
    "type": "indexa_fees",
    "name": "asdfasdf990f69e4_1452522735.pdf",
    "originalName": "",
    "original_name": "",
    "showName": "Comisiones de gestión Indexa, T4-2015",
    "show_name": "Comisiones de gestión Indexa, T4-2015",
    "created_at": "2016-01-11 15:32:15",
    "signed": false
    }
    }
    ]

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/accounts/{account_number}/performance get

get

Retrieve a summary of the performance of the given account

/accounts/{account_number}/portfolio get

get

Retrieve a summary of the portfolio for the given account

/accounts/{account_number}/instrument-transactions get

get

Retrieve a list of all instruments transactions of the given Indexa account.

/accounts/{account_number}/cash-transactions get

get

Retrieve a list of all cash transactions of the given Indexa account.

/accounts/{account_number}/pending-transactions get

get

Retrieve a list of all orders, transfers and cash request that are not in a final state

Secured by JWT

Authentication token

URI Parameters

account_number: required (string)
Account number from /user/me information

Example:
```
    NK1NUTP1
    
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

    {
    "orders": [],
    "transfers": [
    {
    "account_number": "INDEXA01",
    "amount": 0,
    "date": "2017-05-05",
    "direction": "outgoing",
    "instrument_from": {
    "identifier": "IE0032126645",
    "identifier_name": "Código ISIN",
    "name": "Vanguard US 500 Stk Idx -Inst",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645."
    },
    "instrument_to": {
    "identifier": "IE0009591805",
    "identifier_name": "Código ISIN",
    "name": "Vanguard Euro Inv Gr Idx -Inv",
    "description": "El objetivo de este fondo en la inversión en una cartera de gobiernos, agencias, bonos respaldados por hipotecas y bonos de renta fija corporativa coticen o se negocien en mercados reconocidos de la OCDE. Código ISIN: IE0009591805."
    },
    "percentage": 0,
    "status": "pending",
    "titles": 0,
    "type": "partial"
    }
    ],
    "cash_requests": []
    }

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Plans

/plans/{product}/{risk}/history/{investment} get

get

Retrieve historic returns and volatility of the plan given by its product type, risk level and portfolio size (investment)

Secured by JWT_PLATFORM

Authentication token

Secured by JWT

Authentication token

URI Parameters

product: required (string)
Product type for which the questions are requested

Example:
```
    'mutual' or 'pension'
    
```
risk: required (string)
Risk level for which the plan history is requested

Example:
```
    1 to 10
    
```
investment: required (string)
Investment (portfolio size) for which the plan history is requested

Example:
```
    50000
    
```

Headers

X-AUTH-TOKEN: required (string)

JWT user token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJwYXJ0bmVyQGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE0OTQzMTk1NDUsImV4cCI6MTQ5NDM3OTU0NX0.Ca38TMUyuf7YFiL8MN4JNP0NJJYbB49T-XcLAVPSUOc

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

    {
    "plan_return":{
    "ultimo":7.689136836336341,
    "inicio":51.27636640057338,
    "inicio_anual":8.63110991644529
    },
    "volatility":0.059534610706242636,
    "plan_historic_Retrieve":{
    "average":0.0534705221241627,
    "lowest":-0.172491644516577,
    "highest":0.184733502818864,
    "lowest_year":2008,
    "highest_year":2009
    },
    "history_data":
    {
    "20120531":{
    "date":"2012-05-31",
    "return":100,
    "benchmark":100
    },
    "20120630":{
    "date":"2012-06-30",
    "return":100.69917413309058,
    "benchmark":102.7163613392293,
    "percentage_return":0.006991741330905749,
    "benchmark_percentage_return":0.027163613392293007
    },
    "20120731":{
    "date":"2012-07-31",
    "return":103.97287362236169,
    "benchmark":103.44734229762655,
    "percentage_return":0.03250969551095211,
    "benchmark_percentage_return":0.007116499736425919
    },
    "20170531":{
    "date":"2017-05-31",
    "return":151.27636640057338,
    "benchmark":125.47036755321206,
    "percentage_return":-0.000324013698630137,
    "benchmark_percentage_return":0
    }
    }
    }

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/plans/{product}/{risk}/portfolio/{investment} get

get

Retrieve the model portfolio of the plan given its product type, risk level and portfolio size (investment)

Secured by JWT_PLATFORM

Authentication token

Secured by JWT

Authentication token

URI Parameters

product: required (string)
Product type for which the questions are requested

Example:
```
    'mutual' or 'pension'
    
```
risk: required (string)
Risk level for which the plan history is requested

Example:
```
    1 to 10
    
```
investment: required (string)
Investment (portfolio size) for which the plan history is requested

Example:
```
    50000
    
```

Headers

X-AUTH-TOKEN: required (string)

JWT platform token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJwYXJ0bmVyQGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE0OTQzMTk1NDUsImV4cCI6MTQ5NDM3OTU0NX0.Ca38TMUyuf7YFiL8MN4JNP0NJJYbB49T-XcLAVPSUOc

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

    {
    "fee":{
    "funds_ter":0.22660000000000002,
    "funds_management":0.024,
    "funds_depositary":0.0036,
    "account_custody":0.1815,
    "brokerage":0,
    "discretionary_management":0.44999999999999996,
    "tot":0.8581
    },
    "performance_interval":{
    "period":[2017,2018,2019,2020,2021,2022,2023,2024,2025,2026,2027,2028,2029,2030,2031,2032,2033,2034,2035,2036,2037],
    "expected":[100,103.54,107.20531600000002,111.00038418640004,114.9297977865986,118.99831262824421,123.21085289528406,127.57251708777713,132.08858419268446,136.7645200731055,141.60598408369344,146.61883592025623,151.8091427118333,157.18318636383222,162.7474711611119,168.50873164021525,174.47394074027892,180.6503182424848,187.04533950826877,193.6667445268615,200.52254728311243],"worst":[100,90.34656626250002,88.40967924224493,87.65831537759323,87.50636100583061,87.73510178846922,88.23638793130286,88.94834713055597,89.832248957573,90.86234013196179,92.02075821554722,93.29473956100742,94.67497608290626,96.15459402836944,97.72849089747908,99.39288913916863,101.14502659143471,102.98293624124943,104.90528609348605,106.91126055020486,109.00047111275325],"best":[100,118.66008907136245,129.99684963417616,140.55808894403944,150.94740847911993,161.40174365456122,172.04822893478539,182.96851646072247,194.22194452983297,205.8557365313482,217.91012285881544,230.42117002270652,243.42246245428703,256.9461638847728,271.02372221343865,285.6863593051964,300.96542581778516,316.89266855492315,333.50043963071494,350.8218661215736,368.8909924739169],
    "real":[]
    },
    "expected_return":0.0354,
    "instruments":
    [
    {
    "weight": 0.12,
    "instrument": {
    "asset_class": "equity_north_america",
    "asset_class_description": "equity_north_america",
    "bloomberg_code": "IE0032126645 ISIN",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645.",
    "dgs_code": "",
    "identifier_name": "ISIN",
    "isin_code": "IE0032126645",
    "market_code": "FEX",
    "name": "Vanguard US 500 Stk Idx -Inst"
    }
    },
    {
    "weight": 0.26,
    "instrument": {
    "asset_class": "equity_north_america",
    "asset_class_description": "equity_north_america",
    "bloomberg_code": "IE0032126645 ISIN",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645.",
    "dgs_code": "",
    "identifier_name": "ISIN",
    "isin_code": "IE0032126645",
    "market_code": "FEX",
    "name": "Vanguard US 500 Stk Idx -Inst"
    }
    },
    {
    "weight": 0.08,
    "instrument": {
    "asset_class": "equity_north_america",
    "asset_class_description": "equity_north_america",
    "bloomberg_code": "IE0032126645 ISIN",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645.",
    "dgs_code": "",
    "identifier_name": "ISIN",
    "isin_code": "IE0032126645",
    "market_code": "FEX",
    "name": "Vanguard US 500 Stk Idx -Inst"
    }
    },
    {
    "weight": 0,
    "instrument": {
    "asset_class": "equity_north_america",
    "asset_class_description": "equity_north_america",
    "bloomberg_code": "IE0032126645 ISIN",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645.",
    "dgs_code": "",
    "identifier_name": "ISIN",
    "isin_code": "IE0032126645",
    "market_code": "FEX",
    "name": "Vanguard US 500 Stk Idx -Inst"
    }
    },
    {
    "weight": 0.29,
    "instrument": {
    "asset_class": "equity_north_america",
    "asset_class_description": "equity_north_america",
    "bloomberg_code": "IE0032126645 ISIN",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645.",
    "dgs_code": "",
    "identifier_name": "ISIN",
    "isin_code": "IE0032126645",
    "market_code": "FEX",
    "name": "Vanguard US 500 Stk Idx -Inst"
    }
    },
    {
    "weight": 0.25,
    "instrument": {
    "asset_class": "equity_north_america",
    "asset_class_description": "equity_north_america",
    "bloomberg_code": "IE0032126645 ISIN",
    "description": "Es un fondo abierto incorporado en Irlanda cuyo objetivo es hacer un seguimiento del índice Standard & Poor 's 500 Composite Stock Price Index. Por tanto, el fondo invertirá en acciones de grandes empresas estadounidenses. Código ISIN: IE0032126645.",
    "dgs_code": "",
    "identifier_name": "ISIN",
    "isin_code": "IE0032126645",
    "market_code": "FEX",
    "name": "Vanguard US 500 Stk Idx -Inst"
    }
    }
    ]
    ,"benchmark":{
    "description":"\u00cdndice de fondos espa\u00f1oles de renta variable mixta internacional calculado por Inverco. Es el \u00edndice que mejor representa la rentabilidad media de los fondos para un perfil de riesgo moderado a alto en Espa\u00f1a."
    },
    "size":"medium"
    }

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Stats

/stats/performance get

get

Retrieve historic returns

Secured by JWT_PLATFORM

Authentication token

Secured by JWT

Authentication token

Headers

X-AUTH-TOKEN: required (string)

JWT platform token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJwYXJ0bmVyQGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE0OTQzMTk1NDUsImV4cCI6MTQ5NDM3OTU0NX0.Ca38TMUyuf7YFiL8MN4JNP0NJJYbB49T-XcLAVPSUOc

Body

Media type: application/json

Type: object

Properties

from: required (string)
Date range start
to: (string)
Date range end (YYYY-MM-DD). (Default value: today)
product: required (string)
risk: (integer)
Risk level. one in range [1-10] (Default value: 6)
size: (one of small, medium, large)
Portofolio size. (Default value: medium)

HTTP status code 200

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

/stats/volume get

get

Retrieve historic portfolio under management by Indexa Capital

Secured by JWT_PLATFORM

Authentication token

Secured by JWT

Authentication token

Headers

X-AUTH-TOKEN: required (string)

JWT platform token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJwYXJ0bmVyQGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE0OTQzMTk1NDUsImV4cCI6MTQ5NDM3OTU0NX0.Ca38TMUyuf7YFiL8MN4JNP0NJJYbB49T-XcLAVPSUOc

Body

Media type: application/json

Type: object

Properties

from: required (string)
Date range start (YYYY-MM-DD). (Default value: 2015-12-15)
to: (string)
Date range end (YYYY-MM-DD). (Default value: yesterday)

HTTP status code 200

Secured by JWT_PLATFORM

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Secured by JWT

Headers

X-AUTH-TOKEN: required (string)

Authentication token

Example:

    eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0QGluZGV4YWNhcGl0YWwuY29tIiwiaXNzIjoiSW5kZXhhIENhcGl0YWwiLCJpYXQiOjE1MTkxMjY0NDgsImV4cCI6MTUxOTE4NjQ0OCwiZW5kcG9pbnQiOiJodHRwczovL2ludGFwaS5pbmRleGFjYXBpdGFsLmNvbSJ9.P82WNPoxpTSUf9AJfpYFelON4xy6EBec9vE4qEHee1c

Indexa API documentation version v1.6

Authentication

post /auth/authenticate

Body

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 423

Body

Secured by JWT_PLATFORM

Headers

get /auth/refresh-token

HTTP status code 200

Body

HTTP status code 403

Body

Secured by JWT

Headers

Questionnaire

post /questions/{product}/calculate-risk

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 403

Body

Secured by JWT_PLATFORM

Headers

Profile

post /profiles

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 403

Body

Secured by JWT_PLATFORM

Headers

Secured by JWT

Headers

get /profiles/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 404

Body

Secured by JWT

Headers

post /profiles/{id}

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 404

Body

Secured by JWT

Headers

post /profiles/{id}/open-account

URI Parameters

Body

HTTP status code 200

HTTP status code 403

Body

Secured by JWT_PLATFORM

Headers

Users

post /users

Body

HTTP status code 200

Body

HTTP status code 400

Body