Optimization Protection

Present attestations

Before onboarding can be verified, your client must complete the following:

Attestations listed in attestationDocumentIds: This object contains the outstanding attestations that the client must complete - such as disclosure and consent forms, and terms and conditions. The object tells you which documents are required by ID, which you can then request using a GET request to /onboarding/v1/documents/{id}.
Documents listed in documentRequestIds: This object contains any supported documents that may be required, depending on the verification details already submitted. This can include copies of documents that support the verification, such as a Social Security document.

Requests used to get and send attestations

Your client must be able to show that they agree to the terms and conditions of Merchant Services, as well as giving their consent for their data to be used.

To send attestations:

Send a GET request to /onboarding/v1/clients/{id} (or check the response to a PATCH request to the same endpoint). In the response, you can see that an attestation is required when the attestationDocumentIds field in the outstanding object is populated.
Send a GET request to /onboarding/v1/documents/{attestationDocumentId}. In the response, you can see the documentType field shows which document must be attested by the client.
Send a GET request to /onboarding/v1/documents/{attestationDocumentId}/file to return the document itself, so you can display it to your client.
Send a PATCH request to /onboarding/v1/clients/{id} request to pass the attestation.

Get attestation documents

You can see the required documents that need to be attested in the response to the following calls:

GET request to /onboarding/v1/clients
POST request to /onboarding/v1/clients
PATCH request to /onboarding/v1/clients/{id}

The following sample response indicates that an attestation is needed for the document ID c4e4739f-33ed-47f6-82fa-0b1c5c992d0b.

Json

{
  "id": "1000010400",
  "parties": [],
  "partyId": "2000000111",
  "products": [
    "MERCHANT_SERVICES"
  ],
  "outstanding": {
    "attestationDocumentIds": [
      "c4e4739f-33ed-47f6-82fa-0b1c5c992d0b"
    ],
    "documentRequestIds": [],
    "partyIds": [],
    "partyRoles": [],
    "questionIds": [
      "30005",
      "30026",
      "30027"
    ]
  },
  "questionResponses": [],
  "status": "NEW"
}

Check the required document type

To check the required document type that you need to present to your client, send a GET request to /onboarding/v1/documents/{id} with an ID from the attestationDocumentIds in the path.

To access the file itself, send a GET request to /onboarding/v1/documents/{id}/file.

The response contains the document that can be displayed in your platform experience.

Present attestations to your client

Your clients are agreeing to terms and conditions and the content of other written documents when they make their attestation.

This means you need to present attestation documents to your client in a format they can easily read, and provide interaction so they can demonstrate that they have read and understood what they are attesting.

Send attestation

To send the attestation, send a PATCH request to /onboarding/v1/clients/{id} and include the required information in the addAttestations object:

attesterFullName - The full name of the party attesting.
attestationTime - A timestamp of the attestation.
documentId - The given ID of the document being attested - this is the same attestationDocumentIds value you used to get the document.
ipAddress - The client's IP address from which the attestation was made.

Refer to the following sample addAttestations request:

Json

{
  "addAttestations": [
    {
      "attesterFullName": "Monica Gellar",
      "attestationTime": "2025-07-21T17:32:28.000Z",
      "documentId": "c4e4739f-33ed-47f6-82fa-0b1c5c992d0b",
      "ipAddress": "192.158.1.38"
    }
  ]
}

Next steps

After attestation, you can complete onboarding steps and submit client details.