Skip to content
API Reference/
/
User checks events

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL

https://docs.upvest.co

Upvest API Support

api@upvest.co

License

Apache 2.0

Languages
Servers
Sandbox environment

https://sandbox.upvest.co/

Live environment

https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Get a user check by ID

Request

Retrieves a check for a user specified by its ID.

Security
oauth-client-credentials
Path
user_idstring(uuid)required

User unique identifier.

check_idstring(uuid)required

User Check unique identifier.

Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
curl -i -X GET \
  'https://sandbox.upvest.co/users/{user_id}/checks/{check_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'

Responses

OK

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
One of:

The KYC (Know your customer) check is completed by the client sharing the valid and relevant KYC data for the user.

idstring(uuid)required

User Check unique identifier.

user_idstring(uuid)required

User unique identifier.

typestringrequired

The type of check must be “KYC”.

Default "KYC"
check_confirmed_atstring(date-time)required

Completion date and time of the KYC check. Must not be older than 24 months.

data_download_linkstring(url)<= 1000 charactersrequired

Download URL for the KYC evidence file. The file size must not exceed 250 MB.

document_typestringrequired

The type of document used in the KYC process.

  • PASSPORT - Passport
  • ID_CARD - National Identification document
  • RESIDENCE_PERMIT - Residence Permit
  • DRIVING_LICENSE - Driving License
  • TWO_PLUS_TWO_VERIFICATION_PROOF - Two plus two verification proof (for GB residence users only)
Enum"PASSPORT""ID_CARD""RESIDENCE_PERMIT""DRIVING_LICENSE""TWO_PLUS_TWO_VERIFICATION_PROOF"
statusstringrequired

Final status of the KYC check.

  • IN_PROGRESS - KYC check is in progress
  • PASSED - KYC check passed
  • FAILED - KYC check failed
Enum"IN_PROGRESS""PASSED""FAILED"
providerstring<= 100 charactersrequired

Provider that was used to perform the KYC check.

methodstringrequired

Method used for AML-compliant KYC process

  • VIDEO_ID - Video identification
  • IN_PERSON_ID - In-person identification at the post office or the client's outlet
  • ELECTRONIC_ID - Advanced electronic identification methods (namely German eID)
  • LIVENESS_PHOTO_ID - Photos and security features of the identification document in combination with a video-based liveness check (residence country must not be Germany in this case)
  • QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX - Qualified electronic signature accompanied by a bank transaction for verification
  • TWO_PLUS_TWO_VERIFICATION - A method of verifying identity by matching at least two personal details from two separate sources (for GB residence users only)
Enum"VIDEO_ID""IN_PERSON_ID""ELECTRONIC_ID""LIVENESS_PHOTO_ID""QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX""TWO_PLUS_TWO_VERIFICATION"
document_expiration_datestring(date)

Expiration date of the document used in KYC process in YYYY-MM-DD format.

The field is required for the following document types:

  • PASSPORT
  • ID_CARD
  • RESIDENCE_PERMIT
  • DRIVING_LICENSE
nationalitystring^[A-Z]{2}$

Issuing country of the document used in the KYC process. ISO 3166 alpha-2 codes.

The field is required for the following document types:

  • PASSPORT
  • ID_CARD
  • RESIDENCE_PERMIT
  • DRIVING_LICENSE
confirmed_addressobject

Address. Must not be a P.O. box or c/o address.

kyc_updateboolean

Marks this check as a KYC refresh/update as opposed to an initial record.

Response
application/json
{
  "id": "008a82d0-c5a4-4410-9318-d34786429c5a",
  "user_id": "7b39529a-e68c-4688-8242-7549d10d6084",
  "type": "KYC",
  "check_confirmed_at": "2019-08-24T14:15:22Z",
  "data_download_link": "https://bucket.customer.com/ident/user3.zip",
  "document_type": "ID_CARD",
  "document_expiration_date": "2030-01-01",
  "nationality": "DE",
  "status": "PASSED",
  "provider": "KYC provider",
  "method": "VIDEO_ID",
  "confirmed_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  }
}

User checks eventsWebhook

Request

User checks events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

typestringrequired

Event type

Enum"USER_CHECK.CREATED""USER_CHECK.PASSED""USER_CHECK.FAILED"
objectobjectrequired
One of:

The KYC (Know your customer) check is completed by the client sharing the valid and relevant KYC data for the user.

idstring(uuid)required

User Check unique identifier.

user_idstring(uuid)required

User unique identifier.

typestringrequired

The type of check must be “KYC”.

Default "KYC"
check_confirmed_atstring(date-time)required

Completion date and time of the KYC check. Must not be older than 24 months.

data_download_linkstring(url)<= 1000 charactersrequired

Download URL for the KYC evidence file. The file size must not exceed 250 MB.

document_typestringrequired

The type of document used in the KYC process.

  • PASSPORT - Passport
  • ID_CARD - National Identification document
  • RESIDENCE_PERMIT - Residence Permit
  • DRIVING_LICENSE - Driving License
  • TWO_PLUS_TWO_VERIFICATION_PROOF - Two plus two verification proof (for GB residence users only)
Enum"PASSPORT""ID_CARD""RESIDENCE_PERMIT""DRIVING_LICENSE""TWO_PLUS_TWO_VERIFICATION_PROOF"
statusstringrequired

Final status of the KYC check.

  • IN_PROGRESS - KYC check is in progress
  • PASSED - KYC check passed
  • FAILED - KYC check failed
Enum"IN_PROGRESS""PASSED""FAILED"
providerstring<= 100 charactersrequired

Provider that was used to perform the KYC check.

methodstringrequired

Method used for AML-compliant KYC process

  • VIDEO_ID - Video identification
  • IN_PERSON_ID - In-person identification at the post office or the client's outlet
  • ELECTRONIC_ID - Advanced electronic identification methods (namely German eID)
  • LIVENESS_PHOTO_ID - Photos and security features of the identification document in combination with a video-based liveness check (residence country must not be Germany in this case)
  • QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX - Qualified electronic signature accompanied by a bank transaction for verification
  • TWO_PLUS_TWO_VERIFICATION - A method of verifying identity by matching at least two personal details from two separate sources (for GB residence users only)
Enum"VIDEO_ID""IN_PERSON_ID""ELECTRONIC_ID""LIVENESS_PHOTO_ID""QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX""TWO_PLUS_TWO_VERIFICATION"
document_expiration_datestring(date)

Expiration date of the document used in KYC process in YYYY-MM-DD format.

The field is required for the following document types:

  • PASSPORT
  • ID_CARD
  • RESIDENCE_PERMIT
  • DRIVING_LICENSE
nationalitystring^[A-Z]{2}$

Issuing country of the document used in the KYC process. ISO 3166 alpha-2 codes.

The field is required for the following document types:

  • PASSPORT
  • ID_CARD
  • RESIDENCE_PERMIT
  • DRIVING_LICENSE
confirmed_addressobject

Address. Must not be a P.O. box or c/o address.

kyc_updateboolean

Marks this check as a KYC refresh/update as opposed to an initial record.

webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "38fc59d0-fc42-46ef-9512-824773219b2e",
  "created_at": "2021-11-19T13:06:57.820371265Z",
  "type": "USER_CHECK.PASSED",
  "object": {
    "check_confirmed_at": "2021-08-02T15:04:05Z",
    "data_download_link": "https://storage.cloud.google.com/upvest-mock-documents/Test_KYC_documents.zip",
    "document_expiration_date": "2028-01-02",
    "document_type": "PASSPORT",
    "id": "32cbb9a2-dd3b-4e60-a5af-9b41460049dc",
    "user_id": "7b39529a-e68c-4688-8242-7549d10d6084",
    "method": "VIDEO_ID",
    "nationality": "RU",
    "provider": "IDNOW",
    "status": "PASSED",
    "type": "KYC"
  },
  "webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b"
}

Responses

Request has been processed successfully.

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations