BlueSnap.comAPI BasicsPayment APIEmbedded PaymentsReporting & ToolsSupport Guides

Document Upload APIs

The Document Upload API suite allows you to fully automate your KYC workflows with BlueSnap. Using these endpoints, you can proactively submit underwriting documentation and build out a merchant-facing experience for your customers to get approved, all behind your brand.

Notifications

There are two notification types that can trigger the same workflow:

  • Proactive Document Upload Notifications: Notifications will be triggered within moments of merchant creation. Note that prior approval from BlueSnap is required to use this workflow. BlueSnap will determine which files can be passed in based on your business model.
  • Respond to Underwriting Requests Notifications: Notifications are triggered at the time of underwriting review.

Workflow

Step 1: Receive IPN from BlueSnap

Listen for notifications with transactionType= APPLICATION_DOCUMENT_REQUEST. This notification contains the sandbox_id and case_id. You can also find the sandbox ID value as part of the response for a successful Create Merchant POST request or in the Merchant Partner Onboarded IPN. The sandbox ID will be your key for association to inform your customer they have action to take.
For example:

transactionType=APPLICATION_DOCUMENT_REQUEST&sandbox_id=1165743&case_id=5005a00002kAF6sAAG&ipnId=937b8a9a-a31f-48b1-8db6-9b5a331d5c9c

Step 2: Send a Retrieve Documents Request and provide details to your customer

Once you receive the IPN, use the attributes included in it to send a Retrieve Documents API request. This ensures you have the latest information at the time of processing the request.

Retrieve Documents API Request

https://platform.bluesnap.com/services/2/merchants/verification/documents

Request Content

No content is required in the request body. Enter the relevant IDs in the request URL, as follows:

https://platform.bluesnap.com/services/2/merchants/verification/documents?caseid=5005a00002kAF6sAAG&sandboxid=1165743

Response Details

If successful, the response HTTP status code is 200 OK. The response contains the retrieved documentation array and includes real-time details.

documentation object
ParameterTypeDetails
statusstringThis tells you whether BlueSnap has received anything for this document type.
- If it says “Requested”, it means BlueSnap hasn’t received anything yet.
- If it says “Received”, it means that BlueSnap has received at least one file for this docType request.
docUnderwriterNotesstringIf this is populated, it will contain notes written by the underwriter reviewing the application.
docTypestringThe categories of documentation that may be requested. They include:
Possible Values:
- bankDocument
- financialStatements
- processingStatements
- companyRepresentativeId
- miscellaneousRequest
- businessArticle
- businessTaxId
- websiteDescription
- owner1Id (1-4 Owner ID is supported. The FName/LName of the individual will be passed to you in the response for clarity)
docReceivedstringThis value reflects how many files have been received for the docType in question.
docLimitstringThis value reflects how many total files can be passed in for the docType in question.
docGenericDescriptionstringThis is populated with the generic description of the docType in question
Examples
Request Example
curl -v -X GET https://platform.bluesnap.com/services/2/merchants/verification/documents?caseid=5005a00002kAF6sAAG&sandboxid=1165743 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
Response Example
{
    "caseStatus": "Document request pending",
    "sandboxId": "1165743",
    "caseId": "5005a00002kAF6sAAG",
    "documentation": [
        {
            "status": "Requested",
            "docUnderwriterNotes": null,
            "docType": "bankDocument",
            "docsReceived": null,
            "docLimit": 2,
            "docGenericDescription": "A voided check from your financial institution, or a bank letter confirming Legal Entity association with the bank number provided. Temporary checks will not be accepted, and bank letters must be on bank letterhead."
        }
    ]
}

Your customer (merchant applicant) needs to know which docTypes have been requested. If you are using Proactive Document Upload Notifications, these definitions will be the same for all your merchants. If our underwriting team requests a docType, all merchants will see it listed in the GET response.

When customers access your platform, they should be shown requirements with as much detail as possible. We recommend displaying the real-time docGenericDescription and docType. If docUnderwriterNotes is present in the GET response, you should also display this parameter.

Key Points for the Retrieve Documents API Request
  • Receiving a successful GET response signals that you are ready to upload documents using the Document Upload request (as long as the docLimit has not been reached).
  • If you are proactively gathering documentation from your merchants and need to add docTypes, please reach out to your Customer Success Manager so we can update your underwriting settings.

Step 3: Provide your customer the ability to upload files to BlueSnap

Use the Document Upload API request detailed below to provide a document upload experience. The user can upload a file and convert it to Base64 encrypted string. This encrypted string will be the value of the content parameter. Define the title parameter using the filename of the file the customer uploads. You can parse the fileType from what they provide. You can include a field to populate the description parameter with customer notes for our underwriting team. Submit POST requests (one per file), with the B64 string. Display Success to your customer after all operations are complete. Optional: Send a subsequent GET to ensure the applicable ‘status’ variables have updated from “Requested” to “Received”.

File Requirements

  • The file size can not exceed 10MB
  • Include only one file per request
  • Valid fileType values:
    • pdf
    • jpg/jpeg
    • png
    • pdf
    • tif/tiff
    • xls
    • xlsx
    • jpg
    • jpeg

Document Upload API Request

https://platform.bluesnap.com/services/2/merchants/verification/documents

Request Content

The request content includes parameters from the Retrieve Documents API Request response as well as the defining attributes of the document being submitted.

ParameterTypeRequiredNotes
caseIdstringrequiredConsistent with what you initially received in the Application Document Request IPN
sandboxIdstringrequiredConsistent with what you initially received in the Application Document Request IPN
docTypestringrequiredDefine based on what the merchant is uploading/responding to
titlestringrequired
fileTypestringrequired
descriptionstringrequired
contentstringrequiredBase64 encrypted string for the file being submitted
Response Details

If successful, the response HTTP status code is 200 OK and it contains the message "File Uploaded”.

Examples
Request Example
{
    "caseId": "5005a00002hJd75AAC",
    "sandboxId": "1156375",
    "docType": "bankDocument",
    "title": "bankcheck.pdf",
    "fileType": "pdf",
    "description": "My Voided Check",
    "content": "SGVsbG8gQmx1ZVNuYXA="
}
Response Example
{
    "status": "success",
    "message": "File Uploaded"
}

Key Points for Automation

  • The Merchant Partner Onboarded IPN indicates that your application has been received and is being processed.
  • The Application Document Request IPN indicates that one of the following has occurred:
    • Our risk screening engine is ready to receive documents that have been collected.
    • Our underwriting team has a new request for you.
  • You can only upload documents listed in the Retrieve Documents API response details.