Generate Signature

Generate Signature

POST {{Environment_URL}}/v1/registrations/user_correspondents/s3-sign?client-key={{client-key}}&resource_name=document&file_name=image.png&user_id=123

This endpoint generates a pre-signed URL and required form fields to authorize a secure direct file upload to our storage. It must be called first to obtain the temporary credentials needed for the upload request.

Allows any user to get some signature credentials that allow him to upload a specific file to his folder in S3.

  • Pass an Authorization header

  • Pass a valid client_key to identifier your client

  • Pass a resource_name to identifier the resource that you want to upload

    • The common value is: document

  • Pass a file_name with extension

    • The available extensions are: jpg, jpeg, png, gif, pdf

You'll receive a signature with public_url (used to upload a file) and fields attribute (that you have to pass with the file). After uploading the file with the correct fields to the URL generated by this endpoint, you can use the key field (from fields attribute) on createDocumentType or createNewDocumentVersion mutations.

For more information about the upload file, see the Upload file section.

Headers

Name
Value

Authorization

Bearer <token>

Query Parameters

Name
Example Value

client-key

123ABCD456

resource_name

document

file_name

image.png

user_id

123

Response

PreviousUploading Files to Operate Service RemittanceNextUpload File