Submit an application

Beta

POST

/v2/requests/:requestsReference/submit

POST

/api/v2/requests/:requestsReference/submit

curl -X POST https://api-sandbox.payabli.com/api/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c/submit \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "signer": {
    "personReference": "01a0014d-ce1a-7110-9bac-c4c59647a88d",
    "signature": "Marcus J Delgado",
    "signatureType": "type",
    "acceptance": true,
    "pciAttestation": true,
    "reportedSignerIp": "203.0.113.7"
  }
}'

{
  "success": true,
  "message": "Application submitted",
  "traceId": "0HNONVRI1SMEU:0000068E",
  "data": {
    "requestsReference": "3f3caa7b-bdfe-4bf1-814b-30d54859247c",
    "applicationStatus": "submitted",
    "allowedActions": [
      "startVerification",
      "withdraw",
      "abandon",
      "markError"
    ]
  }
}

Submits a draft application for review. Your integration (the applicant) calls this after the business, its people, payment methods, and services are in place. Verification then runs automatically.

The application must have a signer: an owner flagged with isSigner on their business link, or one you name in signer.personReference. Payabli records the signer’s identity from their person record and business link, so update those before you submit. The signer object carries the signature details.

If the application has no signer, the request fails with 422 and the error SIGNER_REQUIRED. If signer.personReference names a person who isn’t an owner, the request fails with 422 and the error SIGNER_NOT_OWNER. If the application isn’t a draft, the request fails with 409 and the error BIZ_004, before any signer check. If signer.reportedSignerIp isn’t a single valid IPv4 or IPv6 address, the request fails with 400 and the error VALIDATION_ERROR, and the application isn’t submitted.

Submit doesn’t check every rule that validate reports, such as the primary controller and ownership rules. Validate the application and resolve its missing fields before you submit.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

requestsReferencestringRequired

The application reference.

Request

This endpoint expects an object.

signerobjectRequired

The signature details for the application's signer, and optionally which person signs.

Response

The action succeeded. The response returns the application's new status and allowed actions.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The lifecycle-action result.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error