Chilkat Online Tools

Node.js / Broker API / Document

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "{{api_key}}";
    http.Password = "{{api_secret}}";

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // [
    //   {
    //     "document_type": "cip_result",
    //     "content": "VGhlcmUgYXJlIG5vIHdpbGQgYWxwYWNhcy4=",
    //     "mime_type": "application/pdf"
    //   },
    //   {
    //     "document_type": "identity_verification",
    //     "document_sub_type": "passport",
    //     "content": "QWxwYWNhcyBjYW5ub3QgbGl2ZSBhbG9uZS4=",
    //     "mime_type": "image/jpeg"
    //   }
    // ]

    var jarr = new chilkat.JsonArray();

    jarr.AddObjectAt(-1);
    // jsonObj_1: JsonObject
    var jsonObj_1 = jarr.ObjectAt(jarr.Size - 1);
    jsonObj_1.UpdateString("document_type","cip_result");
    jsonObj_1.UpdateString("content","VGhlcmUgYXJlIG5vIHdpbGQgYWxwYWNhcy4=");
    jsonObj_1.UpdateString("mime_type","application/pdf");

    jarr.AddObjectAt(-1);
    jsonObj_1 = jarr.ObjectAt(jarr.Size - 1);
    jsonObj_1.UpdateString("document_type","identity_verification");
    jsonObj_1.UpdateString("document_sub_type","passport");
    jsonObj_1.UpdateString("content","QWxwYWNhcyBjYW5ub3QgbGl2ZSBhbG9uZS4=");
    jsonObj_1.UpdateString("mime_type","image/jpeg");

    var sbRequestBody = new chilkat.StringBuilder();
    jarr.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var resp = http.PTextSb("POST","https://domain.com/v1/accounts/:account_id/documents/upload",sbRequestBody,"utf-8","application/json",false,false);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X POST
	-u '{{api_key}}:{{api_secret}}'
	-d '[
  {
    "document_type": "cip_result",
    "content": "VGhlcmUgYXJlIG5vIHdpbGQgYWxwYWNhcy4=",
    "mime_type": "application/pdf"
  },
  {
    "document_type": "identity_verification",
    "document_sub_type": "passport",
    "content": "QWxwYWNhcyBjYW5ub3QgbGl2ZSBhbG9uZS4=",
    "mime_type": "image/jpeg"
  }
]'
https://domain.com/v1/accounts/:account_id/documents/upload

Postman Collection Item JSON

{
  "name": "Document",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "[\n  {\n    \"document_type\": \"cip_result\",\n    \"content\": \"VGhlcmUgYXJlIG5vIHdpbGQgYWxwYWNhcy4=\",\n    \"mime_type\": \"application/pdf\"\n  },\n  {\n    \"document_type\": \"identity_verification\",\n    \"document_sub_type\": \"passport\",\n    \"content\": \"QWxwYWNhcyBjYW5ub3QgbGl2ZSBhbG9uZS4=\",\n    \"mime_type\": \"image/jpeg\"\n  }\n]",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v1/accounts/:account_id/documents/upload",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "accounts",
        ":account_id",
        "documents",
        "upload"
      ],
      "variable": [
        {
          "key": "account_id",
          "value": null
        }
      ]
    },
    "description": "| Key               | Value                 | Requirement |\n|-------------------|-----------------------|:-----------:|\n| `document_upload` | models.DocumentUpload | Required    |"
  },
  "response": [
  ]
}