REST API - Using text tags in Documents

0 votes


I am trying to add text tags into my document using the REST API

I am following this example:

When executing the action I am having the error "500 - Internal Server Error"


{"messageKey":"error.internal.default","message":"Unexpected error. We apologize for any inconvenience this may have caused you, please try again. If the problem persists, please contact our support team.","code":500,"name":"Unhandled Server Error"}


Request Error

"Header ValuesHeader ValuesRequest Headers

The Payload Request is passed through the body request. (Attached file: Payload Request).

The binary used in the request is converted to Base64.


Can you help me?


With the best regards,

Rúben Ferreira


Reply to: REST API - Using text tags in Documents

0 votes

Hi Rúben,


Thanks for your post!

As per your JSON payload, can you try to specify the extraction type as "TEXT_TAGS" like below?

  "documents": [
      "id": "sample-contract",
      "name": "Test Document",
      "extract": true,
      "extractionTypes": [

  "status": "DRAFT",
  "type": "PACKAGE",
  "roles": [
      "id": "signer1",
      "type": "SIGNER",
      "signers": [
          "email": "[email protected]",
          "firstName": "John",
          "lastName": "Smith",
          "id": "signer1"
      "name": "signer1"
  "name": "Text Tags Example Package"


On top of that, just want to make sure with you that you are passing the PDF binary in the request body instead of the base64 string, right? (OneSpan Sign doesn't recognize multipart attachment in base64 format)



Duo Liang OneSpan Evangelism and Partner Integrations Developer

Hello! Looks like you're enjoying the discussion, but haven't signed up for an account.

When you create an account, we remember exactly what you've read, so you always come right back where you left off