Retrieve Document Upload Request

Retrieves details about a document request initiated by BlueSnap underwriting during the Know Your Customer/Anti-Money Laundering (KYC/AML) process.

BlueSnap might require additional documentation to verify the information submitted in the merchant application. To notify you about the document request, BlueSnap sends an APPLICATION_DOCUMENT_REQUEST webhook that includes the case_id and sandbox_id, which you can use to retrieve details about the document request.

Endpoint

https://platform.bluesnap.com/services/2/merchants/verification/documents?caseid={caseId}&sandboxid={sandboxId}

Request Content

This endpoint does not accept a request body. Enter the relevant IDs as query string parameters.

Query String Parameters

Parameter	Required	Description
`caseid`	required	Unique identifier that BlueSnap assigned to this document request. This is the value sent in the `case_id` parameter in the `APPLICATION_DOCUMENT_REQUEST` webhook.
`sandboxid`	required	Unique identifier for the merchant's test account. This is the value sent in the `sandbox_id` parameter in the `APPLICATION_DOCUMENT_REQUEST` webhook.

Response

Parameter	Type	Description
`caseStatus`	string	Current state of the document request.
`sandboxId`	string	Unique identifier for the merchant's test account. This is the value sent in the `sandbox_id` parameter in the `APPLICATION_DOCUMENT_REQUEST` webhook.
`caseId`	string	Unique identifier that BlueSnap assigned to this document request. This is the value sent in the `case_id` parameter in the `APPLICATION_DOCUMENT_REQUEST` webhook.
`documentation`	object	Array of objects where each object describes a requested document.
`status`	string	Whether BlueSnap has received any documents for the `docType` of this document request. - `Requested` — BlueSnap has not received a document. - `Received` — BlueSnap received at least one file of this `docType` for this document request.
`docUnderwriterNotes`	string	Additional guidance from the BlueSnap underwriter that is reviewing the application.
`docType`	string	Category of document that is requested. This property contains one of the following 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)
`docsReceived`	string	Number of documents received for this document request.
`docLimit`	string	Total number of files that you can send for a this `docType`.
`docGenericDescription`	string	Describes the `docType`.

Examples

Requests

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='

Responses

{
    "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."
        }
    ]
}