Compliance

Submit a compliance review

Changed on

Submits the compliance review for evaluation. The review must contain every required attestation for its tier.

post/api/compliance/{organizationId}/reviews/{complianceReviewId}/submit

Request

Path parameters

organizationIdstring uuid required
complianceReviewIdstring uuid required

Request body

acknowledgeWarningsboolean

Set to true to acknowledge any attestation or compliance review warnings and proceed with submission.

Response

Compliance review submitted successfully.

OR

Example response

{
  "tier": "LIGHT",
  "status": {
    "failures": [
      {
        "failureDescription": "Tax ID type CPF is not valid for country US. Allowed types: SSN, ITIN.",
        "failureInfo": {
          "taxIdType": "CPF",
          "country": "US"
        },
        "severity": "WARNING",
        "validationCode": "TAX_ID_COUNTRY_PAIR"
      }
    ]
  }
}

Changes

    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new DOCUMENT_DATA_MISMATCH enum value to the ///// response property for the response status

    • warning

      added the new DOCUMENT_DATA_MISMATCH enum value to the ///// response property for the response status

    • warning

      added the new MissingAttestationsException enum value to the response property for the response status

    • warning

      added the new SignedAgreementRequiredException enum value to the response property for the response status

    • warning

      added the new businessSourceOfFundsDocuments enum value to the /// response property for the response status

    • info

      added response discriminator for the response status

    • info

      added the non-success response with the status

    • info

      response property oneOf[subschema #1: Individual compliance review submitted]/status/oneOf[subschema #2: Submission Validations Failed]/failures/items/validationCode deprecated

    • info

      response property oneOf[subschema #2: Business compliance review submitted]/status/oneOf[subschema #2: Submission Validations Failed]/failures/items/validationCode deprecated

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status