SYSCAP API Reference Documentation

Getting Started

Requests against the SYSCAP API require valid JWT token. Here is an example to use the API with Curl.


  curl --request GET \
    --url https://api.syscap.com.mx/promissory_notes \
    --header 'Authorization: Bearer < token >'

Resources

Bank accounts
Bank Accounts Endpoints work for two different sources: investors and promoters

Resource Description
GET /investors/:investor_id/bank_accounts?page=&per= Bank accounts from specific investor
GET /promoters/:promoter_id/bank_accounts?page=&per= Bank accounts from specific promoter
GET /investors/:investor_id/bank_accounts/:id Specific bank account from specific investor
GET /promoters/:promoter_id/bank_accounts/:id Specific bank account from specific promoter

Catalogs

Resource Description
GET /countries List of countries
GET /states List of states
GET /cities List of cities
GET /banxico_banks List of banxico_banks
GET /nationalities List of nationalities
GET /currencies List of currencies
GET /tiies List of tiies
GET /cetes List of cetes
GET /libor_usd List of libor_usd
GET /exchange_rates List of exchange_rates
GET /variable_rates List of variable_rates

Contacts
Contacts Endpoints work for two different sources: investors and promoters

Resource Description
GET /investors/:investor_id/contacts?page=&per= Contacts from specific investor
GET /promoters/:promoter_id/contacts?page=&per= Contacts from specific promoter
GET /investors/:investor_id/contacts/:id Specific contct from specific investor
GET /promoters/:promoter_id/contacts/:id Specific contct from specific promoter

Dashboard
Dashboard Endpoints

Resource Description
GET /widgets?dashboard=general Widgets total funds, funds weighted rate, active funds and active funders data from dashboard

Fiscal addresses
Fiscal Addresses Endpoints work for two different sources: investors and promoters

Resource Description
GET /investors/:investor_id/fiscal_addresses?page=&per= Fiscal addresses from specific investor
GET /promoters/:promoter_id/fiscal_addresses?page=&per= Fiscal addresses from specific promoter
GET /investors/:investor_id/fiscal_addresses/:id Specific fiscal address from specific investor
GET /promoters/:promoter_id/fiscal_addresses/:id Specific fiscal address from specific promoter

Investors
Investors Endpoints

Resource Description
GET /investors?page=&per= List of investors
GET /investors/widgets Widgets information for investors
GET /investors/:id Specific investor
GET /investors/:id/promissory_notes?page=&per= Promissory notes from specific investor
GET /investors/:id/statements?page=&per= Statements from specific investor

Investors Addresses

Resource Description
GET /investors/:investor_id/addresses Addresses from specific investor
GET /investors/:investor_id/addresses/:id Specific address

Investors Documentation

Resource Description
GET /investors/:investor_id/documentation Documents from specific investor
GET /investors/:investor_id/documentation/:id Specific document

Monthly cuts
Monthly Cuts Endpoints

Resource Description
GET /monthly_cuts?page=&per= List of monthly cuts
GET /monthly_cuts/:id Specific monthly cut
GET /monthly_cuts/:id/amounts Amounts from specific monthly cut
GET /monthly_cuts/:id/analysis Analysis from specific monthly cut

Monthly Cut Statements

Resource Description
GET /monthly_cuts/:monthly_cut_id/statements Statements from specific monthly cut
GET /monthly_cuts/:monthly_cut_id/statements/:id Specific statement

Payments
Payments Endpoints

Resource Description
GET /payments?page=&per= List of payments
GET /payments/:id Specific payment

Promissory notes
Promissory Note Endpoints

Resource Description
GET /promissory_notes?page=&per= List of Promissory Notes
GET /promissory_note/:id Specific promissory note

Promissory Notes Interests

Resource Description
GET /promissory_note/:promissory_note_id/interests Interests from specific promissory note

Promissory Notes Transactions

Resource Description
GET /promissory_note/:promissory_note_id/transactions Transactions from specific promissory note

Promoters
Promoters Endpoints

Resource Description
GET /promoters?page=&per= List of promoters
GET /promoters/:id Specific promoter
GET /promoters/:id/prospections Prospections from specific promoter
GET /promoters/:id/investors Investors from specific promoter

Prospects
Prospects Endpoints

Resource Description
GET /prospects?page=&per= List of Prospects
GET /prospects/:id Specific prospect
GET /prospects/:id/prospections Prospections from specific prospect

Users
Users Endpoints

Resource Description
GET /users?page=&per= List of users
GET /users/:id Specific user