Chilkat Online Tools

phpAx / Broker API / Document

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$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"
//   }
// ]

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonArray')
$jarr = new COM("Chilkat.JsonArray");

$jarr->AddObjectAt(-1);
// jsonObj_1 is a Chilkat.JsonObject
$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 is a Chilkat.JsonObject
$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');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$jarr->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('POST','https://domain.com/v1/accounts/:account_id/documents/upload',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

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": [
  ]
}