OverviewPlatformsAPI ReferenceResources
Phone Numbers

Upload a KYC document

POSThttps://zernio.com/api/v1/phone-numbers/kyc/upload-document

Upload ONE document and get back its provider document id, to reference from POST /v1/phone-numbers/kyc via documents[].documentId.

  • Send the RAW file bytes as the request body (not base64).
  • Put the filename in the X-Filename header.
  • Uploading documents one-per-request keeps each request under the ~4.5MB body limit.

The document streams straight to the number provider and is not stored by Zernio.

Authentication

AuthorizationBearer tokenRequired

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

Request Body

application/octet-stream

TypeScript Definitions

Use the request body type in TypeScript.

body*file
Formatbinary

Headers

X-FilenamestringRequired

URL-encoded original filename.

Responses

Success· the request worked

Errors· the request failed

POST/v1/phone-numbers/kyc/upload-document
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.phonenumbers.uploadPhoneNumberKycDocument();console.log(data);
{  "documentId": "string"}
OpenAPI specification
Was this page helpful?