Request supporting documents

You can request documents from a participant within the signature process. Once these documents are captured, they are hashed, timestamped add added to the transaction. You can specify which documents are required among:

  • Identity documents:
    • Identity card
    • Driving license
    • Passport
    • Residence permit
  • Proof of address
  • Bank details
  • Bank statement
  • Tax statement
  • Payslip
  • Kbis
  • Other

If you request the same document_type more than once for the same actor, you must pass a tag of your choice to differenciate each request. Otherwise, your request will overwrite the previous one.

Beyond basic document capture, you may also require document control. The document control feature automatically recognizes and classifies captured documents, eliminating the need for manual indexing and reducing the risk of typing errors.

Before requesting document control for captured documents, ensure that the document control feature is activated on your account.

Depending on the type of document, you might need to consider the freshness_limit or covered_period parameters.

  • The freshness_limit of a document is the duration after its issuance date during which its content is considered valid, accurate, and up-to-date.

  • The covered_period of a document is the time span the document’s content applies to.

The use of these control parameters depends on whether the document control feature is activated on your workspace:

  • If the feature is not activated, you need to manually include these checks in your requests (see examples below).

  • If the feature is activated, you need to contact your account manager to configure these checks as default settings for your workspace.

Note that you can also add a guideline for the participant to give him/her additional information about the document requested (only if the document control feature is not activated on your workspace).

Request identity documents

To request one or more identity documents, send a request to POST/v1/transactions/{transaction_id}/captures/identity_document. You must specify how many items are required among a set of accepted ones. For example, you can specify if the participant should provide an identity card or a passport, or if both are required. In the following request example, the participant must provide an identity card and a passport (the number of accepted_identity_documents equals the number of total_items_required).

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/identity_document \
-d [email protected] \
-d accepted_identity_documents=identity_card \
-d accepted_identity_documents=passport \
-d total_items_required=2 \
-d guideline="the document must be in color."

Request a proof of address

To request a proof of address, send a request to POST/v1/transactions/{tx_id}/captures/address_proof.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/address_proof \
-d [email protected] \
-d guideline=Please attach your proof of address which issue date is less than 6 months.

If the document control feature is not activated, you need to add the freshness_limit argument to your request, as in the example below. Possible values are :

  • 3: the document’s issue date must be less than 3 months (default value).
  • 6: the document’s issue date must be less than 6 months.
  • 12: the document’s issue date must be less than 12 months.
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/address_proof \
-d [email protected] \
-d guideline=Please attach your proof of address which issue date is less than 6 months.
-d freshness_limit=6

Request bank details (IBAN)

To request bank details (IBAN), send a request to POST/v1/transactions/{tx_id}/captures/iban. In the following example, we request two IBANs, and we must therefore pass a tag to differentiate the requests:

curl 
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/iban \
-d [email protected] \
-d tag=personal \
-d guideline=Please attach your personal IBAN 

curl 
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/iban \
-d [email protected] \
-d tag=professional \
-d guideline=Please attach your professional IBAN

Request a bank statement

To request a bank statement, send a request to POST/v1/transactions/{tx_id}/captures/bank_statement.

curl 
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/bank_statement \
-d [email protected] \
-d guideline=Please attach your bank statement covering the past 4 months.

If the document control feature is not activated, you must specify the wanted period via the covered_period argument. For bank statements, the covered_period is expressed in months and possible values are between 1 for the past month and 6 for the past 6 months (default value is 3). In the example below, we request a bank statement covering the past 4 months.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/bank_statement \
-d [email protected] \
-d guideline=Please attach your bank statement covering the past 4 months. \
-d covered_period=4

Request a tax statement

To request a tax statement, send a request to POST/v1/transactions/{tx_id}/captures/tax_statement.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/tax_statement \
-d [email protected] \
-d guideline=Please attach your tax statement for the past 3 years.

If the document control feature is not activated, you must specify the wanted period via the covered_period argument. For tax statements, the covered_period is expressed in years and possible values are between 1 for the past year and 5 for the past 5 years (default value is 2). In the example below, we request tax statements covering the past 3 years.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/tax_statement \
-d [email protected] \
-d guideline=Please attach your tax statement for the past 3 years. \
-d covered_period=3

Request a payslip

To request a payslip, send a request to POST/v1/transactions/{tx_id}/captures/pay_slip.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/pay_slip \
-d [email protected]

If the document control feature is not activated, you must specify the wanted period via the covered_period argument. For payslips, the covered_period is expressed in months and possible values are between 1 for the past month and 6 for the past 6 months (default value is 3). In the example below, we request a payslip covering the past 4 months.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/pay_slip \
-d [email protected] \
-d guideline=Please attach your payslip covering the past 4 months.
-d covered_period=4

Request a kbis

To request a kbis, send a request to POST/v1/transactions/{tx_id}/captures/kbis.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/kbis \
-d [email protected]
-d guideline=Please attach your kbis which issue date is less than 6 months.

If the document control feature is not activated, you need to add the freshness_limit argument to your request, as in the example below. Possible values are :

  • 3: the document’s issue date must be less than 3 months (default value).
  • 6: the document’s issue date must be less than 6 months.
  • 12: the document’s issue date must be less than 12 months.
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/kbis \
-d [email protected] \
-d freshness_limit=6

Request other document types

When requesting a type of document other, you must pass a name for that document so the participant knows what is expected.

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/other \
-d [email protected] \
-d guideline=Please attach your vitale card.
-d tag=vitale \
-d name=vitale

Delete a capture request

To delete a capture request, send a request to POST /v1/transactions/{transaction_id}/captures/ add the delete boolean and set it to true:

curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/captures/identity_document \
-d [email protected] \
-d document_type=identity_document \
-d delete=true
Set inactivity alert
← Previous
Chat with a participant
Next →
Developer tools
Guides
Services
API reference