Skip to main content
POST
/
v1
/
documents
/
collections
Create a new document collection
curl --request POST \
  --url https://prod.truv.com/v1/documents/collections/ \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>' \
  --data '
{
  "documents": [
    {
      "filename": "paystub.pdf",
      "mime_type": "application/pdf",
      "content": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwo...",
      "user_id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789"
    }
  ],
  "users": [
    {
      "id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789",
      "full_name": "John Doe",
      "ssn": "991919991"
    }
  ]
}
'
{
  "collection_id": "a1b2c3d4e5f6478899aabbccddeeff00",
  "uploaded_files": [
    {
      "file_id": "f1234567890abcdef1234567890abcde",
      "filename": "paystub.pdf",
      "mime_type": "application/pdf",
      "status": "validated",
      "validations": {
        "is_viable_size": true,
        "is_supported_type": true,
        "is_accessible": true,
        "is_valid": true,
        "is_readable": true,
        "is_unique": true
      },
      "user_id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789"
    }
  ],
  "documents": [
    {
      "document_id": "d0c1234567890abcdef1234567890abc",
      "file_id": "f1234567890abcdef1234567890abcde",
      "document_type": "PAYSTUB",
      "status": "successful",
      "start_page": 1,
      "end_page": 2,
      "document_subtype": null,
      "first_name": "John",
      "last_name": "Doe",
      "user_id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789"
    }
  ],
  "users": [
    {
      "id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789",
      "first_name": "John",
      "last_name": "Doe"
    }
  ]
}

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Body

application/json
documents
Documents · object[]
required

Array of documents to upload (maximum 10 files per request)

Required array length: 1 - 10 elements
users
Users · object[]

Array of users to create/update in this collection (optional). Documents can be automatically matched to users by name, or explicitly assigned via user_id/external_user_id in the documents array.

User information for collection. Either 'id' or 'external_user_id' must be provided, but not both.

Response

collection_id
string
required
Example:

"a1b2c3d4e5f6478899aabbccddeeff00"

uploaded_files
Uploaded files · object[]
required
documents
Recognized documents · object[]
required
users
Users · object[]
required