/api/v1/merchant/signatureCertificate

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Application Sign Certificate

Submits a signed certificate (as a Base64-encoded PDF) to complete the online signature step for a merchant's Merchant Processing Agreement (MPA). This endpoint is called after the merchant has reviewed and signed the MPA, providing the signed document back to the system for record-keeping and workflow progression.

Endpoint

POST /api/v1/merchant/signatureCertificate

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint as part of the MPA signing workflow, after generating the MPA PDF (POST /api/v1/merchant/generateMPAPDF) and initiating the signature request. Once the signer has completed signing, call this endpoint to upload the resulting signed certificate PDF. The file must be a valid PDF and the filename must end in .pdf. This step is required to advance the merchant's status through the signing workflow.

Request Body

FieldTypeRequiredDescription
idinteger (int32)NoThe merchant profile ID associated with the certificate
datastring (byte, Base64)YesThe signed certificate file content encoded as a Base64 string
fileNamestringYesThe filename of the certificate — must match pattern ^.+\.pdf$ (must end in .pdf)
{
  "id": 48291,
  "data": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCg==",
  "fileName": "mpa_signed_48291.pdf"
}

Response

200 OK

FieldTypeDescription
requestIdintegerUnique identifier for this API request
successbooleantrue if the certificate was accepted and saved successfully
errorstringError message if the submission failed
validationErrorsarrayList of field-level validation errors with field and error properties
{
  "requestId": 77042,
  "success": true,
  "error": null,
  "validationErrors": []
}

Error Codes

CodeWhen it happens
400data or fileName is missing, or fileName does not end in .pdf
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404Merchant with the specified id not found
500Internal server error

Common Mistakes

  • Providing a fileName that does not end in .pdf — the field validates against the regex ^.+\.pdf$.
  • Sending raw binary data instead of a Base64-encoded string in the data field — always encode the PDF bytes as Base64 before including in the request body.
  • Omitting id when the system cannot infer the merchant from context — include the merchant profile ID whenever available.
  • Uploading a corrupted or truncated Base64 string — ensure the full PDF is encoded without line breaks or padding issues.

Related Endpoints

  • POST /api/v1/merchant/generateMPAPDF — generate the MPA PDF that the merchant will sign
  • POST /api/v1/merchant/requestSignature — initiate the online signature request for the merchant
  • GET /api/v1/merchant/getSigningStatus — check the current status of the signing workflow

Example

curl -X POST https://hq.staging.netevia.dev/api/v1/merchant/signatureCertificate \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 48291,
    "data": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg==",
    "fileName": "mpa_signed_48291.pdf"
  }'
Body Params
int32
string
required
string
required
^.+\.pdf$
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json