Account Document

Account document endpoint can be used to add a document to the Veem account. This could be, for example, a Personal Id, Proof of address, or Business Registration.

Add document

POST https://sandbox-api.veem.com/veem/v1.2/account/documents/{DocumentType}

📘
Headers
Three headers are required to use this endpoint.
Required Headers
Name
Type
Required
Description
Authorization
string
Yes
Bearer token (OAuth 2.0) This header holds the bearer token required to use Veem's public API, and belongs to the owner account. Failure to use a valid bearer token will result in a 404 (Not Found) status code in the response. An example of a valid header value is as follows: Bearer c047594b-082c-4da1-be89-08fe3770f4b3
See Get Access Token section to generate your Bearer token
X-Request-Id
string
Yes
This is a unique string that identifies the current API request, and should follow the UUID format. Reusing this header without changing the value will result in a 409 (Conflict) status code in the response. An example X-request-id is as follows:
48855846-628d-4177-b071-80332a116f0a
Content-Type
string
Yes
The content type of the request. Must be application/json

Name	Type	Required	Description
`Authorization`	`string`	Yes	Bearer token (OAuth 2.0) This header holds the bearer token required to use Veem's public API, and belongs to the owner account. Failure to use a valid bearer token will result in a 404 (Not Found) status code in the response. An example of a valid header value is as follows: `Bearer c047594b-082c-4da1-be89-08fe3770f4b3` See Get Access Token section to generate your Bearer token
`X-Request-Id`	`string`	Yes	This is a unique string that identifies the current API request, and should follow the UUID format. Reusing this header without changing the value will result in a 409 (Conflict) status code in the response. An example X-request-id is as follows: `48855846-628d-4177-b071-80332a116f0a`
`Content-Type`	`string`	Yes	The content type of the request. Must be `application/json`

Query Parameters

Document Types

{DocumentType} query param can be any of the following

Parameter	Description
Address	Proof of address (e.g. Bank statement)
Business	Business Registration (e.g. Business registration, Business license)
Identity	Personal Id (e.g. Passport, Driver's License, Government ID Card)
SelfieId	Selfie with Id photo
PhotoIdFront	ID Front
PhotoIdBack	ID Back
FundsSource	Source of funds (e.g. Bank statement)
BeneficialOwnership	Beneficial ownership
ProofOfBalance	Proof of balance (e.g. Bank statement, Screen capture of bank balance)
AccountantAuthorization	Accountant authorization
NonProfitRegistration	Non-profit registration
NonProfitAuthorizedSignatories	Non-profit authorized signatories
Other	Other

Request Parameters

👍
Partner Notes:

A partner account can be configured to make this API request on behalf of their customers. This requires internal configuration for the partner account by Veem. Once the internal configuration is enabled, the API request can be made using partner account bearer token.

onBehalfAccountId is an optional parameter, this needs to be included on the request body in case of partner making an API request on behalf of their customer. This is the customer Veem account ID, e.g. 453221.

Body

Body is expected as form-data with the follow elements:

Field	Description
file	Multi-part File content Allowed extensions: bmp, doc, docx, gif, jpg, jpeg, pdf, png, tif, tiff, xls, xlsx
request	JSON with the following structure `{ "description": "document short description" }`

Field

Description

file

Multi-part File content

Allowed extensions: bmp, doc, docx, gif, jpg, jpeg, pdf, png, tif, tiff, xls, xlsx

request

JSON with the following structure

{ "description": "document short description" }

Example

curl --location 'https://sandbox-api.veem.com/veem/v1.2/account/documents/SelfieId'  
--header 'Authorization: Bearer abcdc463-cf95-b458-ea3561deda4c'  
--header 'X-REQUEST-ID: 794f264a-4eb9-be08-a366ef8d9ab3'  
--header 'Cookie: XSRF-TOKEN=c1ae52ec-4c06-afda-a814490183bd; SESSION=McxMjMzM2ItY2E5NS00ZjkAzZDk1ZGY4ZTdj'  
--form 'file=@"/C:/Users/oscar/Pictures/SelfieId.png"'  
--form 'request="{\"description\": \"Selfie photo with Id\"}";type=application/json'

Response

{
  "id": 2355,
	"type": "SelfieId",
  "originalFileName": "SelfieId.png",
  "processingState": "ReadyForReview",
  "timeProcessed": null,
  "status": "Active",
  "description": "Selfie photo with Id"
}