Upvest Investment API.
API Reference/- Get a user identifier by ID
Get user identifiers
Create a user identifier
Update a user identifier by ID
Get a user identifier by...
Upvest Investment API (1.75.0)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Request
Creates a new identifier for a user that will be used for transaction reporting obligations. This identifier is required for user activation if the user's nationalities do not allow reporting using the CONCAT format. More information can be found in the guides.
Security
oauth-client-credentials
Headers
Bodyapplication/jsonBearer (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
Identifier type.
- NATIONAL_ID -
- PASSPORT -
Default "NATIONAL_ID"
Enum"NATIONAL_ID""PASSPORT"
Accepted country code. ISO 3166-1 alpha-2 codes.
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Identifier value. See guide here
Identifier standard abbreviation. If it's not provided, issuing country's corresponding 1st Priority Identifier Standard will be used by default. See guide here
- Sandbox environment
https://sandbox.upvest.co/users/{user_id}/identifiers
- Live environment
https://api.upvest.co/users/{user_id}/identifiers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://sandbox.upvest.co/users/{user_id}/identifiers' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-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' \
-d '{
"type": "NATIONAL_ID",
"issuing_country": "PL",
"identifier_standard": "PESEL",
"identifier": "83053078917"
}'The user identifier is created.
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
Identifier standard abbreviation. If it's not provided, issuing country's corresponding 1st Priority Identifier Standard will be used by default. See guide here
Identifier value. See guide here
Identifier type.
- NATIONAL_ID -
- PASSPORT -
Default "NATIONAL_ID"
Enum"NATIONAL_ID""PASSPORT"
Accepted country code. ISO 3166-1 alpha-2 codes.
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Response
application/json
{ "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202", "created_at": "2021-07-21T14:10:00.00Z", "updated_at": "2021-07-21T14:10:00.00Z", "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be203", "type": "NATIONAL_ID", "issuing_country": "PL", "identifier_standard": "PESEL", "identifier": "83053078917" }
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}/identifiers/{identifier_id}
- Live environment
https://api.upvest.co/users/{user_id}/identifiers/{identifier_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/users/{user_id}/identifiers/{identifier_id}' \
-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
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
Identifier standard abbreviation. If it's not provided, issuing country's corresponding 1st Priority Identifier Standard will be used by default. See guide here
Identifier value. See guide here
Identifier type.
- NATIONAL_ID -
- PASSPORT -
Default "NATIONAL_ID"
Enum"NATIONAL_ID""PASSPORT"
Accepted country code. ISO 3166-1 alpha-2 codes.
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Response
application/json
{ "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202", "created_at": "2021-07-21T14:10:00.00Z", "updated_at": "2021-07-21T14:10:00.00Z", "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be203", "type": "NATIONAL_ID", "issuing_country": "PL", "identifier_standard": "PESEL", "identifier": "83053078917" }
Headers
Bodyapplication/jsonBearer (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
Identifier value. See guide here
- Sandbox environment
https://sandbox.upvest.co/users/{user_id}/identifiers/{identifier_id}
- Live environment
https://api.upvest.co/users/{user_id}/identifiers/{identifier_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://sandbox.upvest.co/users/{user_id}/identifiers/{identifier_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-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' \
-d '{
"identifier": "83053078111"
}'The user identifier is updated.
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
Identifier standard abbreviation. If it's not provided, issuing country's corresponding 1st Priority Identifier Standard will be used by default. See guide here
Identifier value. See guide here
Identifier type.
- NATIONAL_ID -
- PASSPORT -
Default "NATIONAL_ID"
Enum"NATIONAL_ID""PASSPORT"
Accepted country code. ISO 3166-1 alpha-2 codes.
Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Response
application/json
{ "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202", "created_at": "2021-07-21T14:10:00.00Z", "updated_at": "2021-07-22T15:20:10.00Z", "user_id": "00000ec2-d2ca-49ff-bbea-b92b5c3be203", "type": "NATIONAL_ID", "issuing_country": "PL", "identifier_standard": "PESEL", "identifier": "83053078111" }