Assignments

Estimate assignment cost

Changed on

Estimate the cost of creating an assignment without creating it, returning a cost breakdown and the current account balances. Signer IDs are not required — only the verification/notification method affects cost. Each assignment consumes 1 document from the plan allowance; if exhausted, an extra document is charged from credits (needs_extra_document = true). blocking_reason may be PendingPayment, InsufficientDocuments or InsufficientCredits.

Pricing

Per-unit costs (in credits) used to build the estimate:

ItemCost
Extra document1 credit
Email notification0 credits
WhatsApp notification0.45 credits
Digital certificate signature (per signer)0.5 credits
Identity document verification (per signer)depends on the plan, see the table below
PlanPrice per signer
Free1.5 credits
Standard1 credit
Pro0.5 credits
Other plans and enterprise contracts0.25 credits

Email and Whatsapp verification are not priced separately — their only line in the breakdown is their notification. A Whatsapp-verified signer therefore shows up as a WhatsApp notification, because that channel is mandatory for that verification method. A DigitalCertificate signer adds the digital-certificate signature cost on top of its notification cost; it appears in the breakdown under the SignatureDigitalCertificate code. An IdDocumentFaceMatchBasic signer likewise adds your plan's verification price on top of its notification, under the VerificationIdDocumentFaceMatchBasic code.

Copy as Markdown Open in ChatGPT Open in Claude

post/v1/documents/{documentId}/assignments/estimate-cost

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/documents/{documentId}/assignments/estimate-cost
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

documentIdstring required

Document ID.

Request body

method'virtual' | 'collect'

Send the method you will create the assignment with. With collect, a DigitalCertificate signer returns 400, because certificate signing works only on virtual assignments.

entriesobject[]

Required for collect.

Example request

{
  "method": "virtual",
  "signers": [
    {
      "verification_method": "Whatsapp"
    }
  ]
}

Response

Cost estimate and balances

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "documents": 1,
    "credits": 0.9,
    "needs_extra_document": true,
    "extra_document_cost": 1,
    "total_credits": 1.9,
    "breakdown": [
      {
        "code": "NotificationWhatsapp",
        "name": "Whatsapp Notification",
        "cost": 0.9,
        "quantity": 2,
        "unit_cost": 0.45
      }
    ],
    "credit_balance": 10,
    "has_sufficient_resources": true
  }
}

Changes

    • info

      added the new IdDocumentFaceMatchBasic enum value to the request property //