Upvest Investment API.
Upvest Investment API (1.75.0)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Query
Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.
Default "ASC"
Enum"ASC""DESC"
Use the offset argument to specify where in the list of results to start when returning items for a particular query.
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/users/{user_id}/tax_exemptions
- Live environment
https://api.upvest.co/users/{user_id}/tax_exemptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/users/{user_id}/tax_exemptions?sort=created_at&order=ASC&offset=0&limit=100' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'OK
Tax exemption status
- NEW - The tax exemption request is created.
- ACTIVE - The tax exemption is valid and active for the current year.
- EXPIRED - The tax exemption is no longer
ACTIVEand thevalid_to_datealready lies in the past. An update is not possible. - CANCELLED - The tax exemption could not be created or was cancelled.
Enum"NEW""ACTIVE""EXPIRED""CANCELLED"
Country code. ISO 3166 alpha-2 Codes.
Date from which the tax exemption is valid. RFC 3339, section 5.6
Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). RFC 3339, section 5.6
Tax exemption type
- SINGLE - Tax exemption for Individual.
- MARRIED - Tax exemption for married couples.
Enum"SINGLE""MARRIED"
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
Response
application/json
{ "meta": { "offset": 0, "limit": 100, "count": 1, "total_count": 1, "sort": "created_at", "order": "ASC" }, "data": [ { … } ] }
Bodyapplication/json
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
Tax exemption events webhook type
- TAX_EXEMPTION.CREATED - Tax exemption successfully created.
- TAX_EXEMPTION.UPDATED - Tax exemption successfully updated.
- TAX_EXEMPTION.DELETED - Tax exemption successfully deleted.
Enum"TAX_EXEMPTION.CREATED""TAX_EXEMPTION.UPDATED""TAX_EXEMPTION.DELETED"
Tax exemption status
- NEW - The tax exemption request is created.
- ACTIVE - The tax exemption is valid and active for the current year.
- EXPIRED - The tax exemption is no longer
ACTIVEand thevalid_to_datealready lies in the past. An update is not possible. - CANCELLED - The tax exemption could not be created or was cancelled.
Enum"NEW""ACTIVE""EXPIRED""CANCELLED"
Country code. ISO 3166 alpha-2 Codes.
Date from which the tax exemption is valid. RFC 3339, section 5.6
Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). RFC 3339, section 5.6
Tax exemption type
- SINGLE - Tax exemption for Individual.
- MARRIED - Tax exemption for married couples.
Enum"SINGLE""MARRIED"
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
- Sandbox environment
https://sandbox.upvest.co/Tax exemption events
- Live environment
https://api.upvest.co/Tax exemption events
application/json
{ "id": "295cf14f-368c-450e-b57e-48d115d30fe4", "created_at": "2024-01-01T10:34:43Z", "type": "TAX_EXEMPTION.CREATED", "object": { "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1", "created_at": "2024-01-01T10:33:43Z", "updated_at": "2024-01-01T10:33:43Z", "status": "ACTIVE", "user_ids": [ … ], "country": "DE", "valid_from_date": "2024-01-01", "valid_to_date": "2024-12-31", "tax_exemption_details": { … } }, "webhook_id": "4a80c45f-204c-4498-ac20-d900a846e166" }
Bodyapplication/json
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
Type of the tax exemption failure events webhook.
- TAX_EXEMPTION.CREATION_FAILED - Tax exemption creation failed.
- TAX_EXEMPTION.UPDATE_FAILED - Tax exemption update failed.
- TAX_EXEMPTION.DELETION_FAILED - Tax exemption deletion failed.
Enum"TAX_EXEMPTION.CREATION_FAILED""TAX_EXEMPTION.UPDATE_FAILED""TAX_EXEMPTION.DELETION_FAILED"
Tax exemption status
- NEW - The tax exemption request is created.
- ACTIVE - The tax exemption is valid and active for the current year.
- EXPIRED - The tax exemption is no longer
ACTIVEand thevalid_to_datealready lies in the past. An update is not possible. - CANCELLED - The tax exemption could not be created or was cancelled.
Enum"NEW""ACTIVE""EXPIRED""CANCELLED"
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
- Sandbox environment
https://sandbox.upvest.co/Tax exemption failure events
- Live environment
https://api.upvest.co/Tax exemption failure events
application/json
{ "id": "2ce641a1-e89c-43be-b8d8-981d4aac5bd5", "created_at": "2024-01-01T10:34:43Z", "type": "TAX_EXEMPTION.CREATION_FAILED", "object": { "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1", "created_at": "2024-01-01T10:33:43Z", "updated_at": "2024-01-01T10:33:43Z", "reason": "Missing TIN", "status": "CANCELLED", "user_ids": [ … ] }, "webhook_id": "606e3c01-c9cf-4073-900e-718bfc521953" }