Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Compliance Checks

Dismiss Compliance Check

Indicate that you have manually verified a vendor with compliance issues and wish to send them Payables.

post/v1/companies/{company_id}/compliance-checks/dismiss

Path parameters

company_idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The Company ID.

Request body

acting_team_memberstring uuid required

The ID of the TeamMember performing this action. This will be displayed in the Routable Dashboard.

Response

OK

idstring uuid

The ID of the report.

object'ComplianceReport'

The type of object.

created_atstring date-time

The timestamp at which the ComplianceReport was generated.

status'cant_validate' | 'dismissed' | 'not_evaluated' | 'outdated' | 'passed' | 'queued' | 'review_required'

Compliance Check status for a Company:

  • cant_validate: An error happened and the verification couldn't be finished.
  • dismissed: There were issues found (review_required), but they were dismissed by a team member.
  • not_evaluated: Not enrolled for risk monitoring.
  • outdated: When legal data changes outside of the tax flows.
  • passed: Risk checks are all clear.
  • queued: Company was queued for enrollment in risk monitoring.
  • review_required: Identified issues for the entity - Watchlist hits or a TIN mismatch.

Example response

{
  "checks": [
    {
      "issues": [
        {
          "subject_name": "Sarah Smith"
        }
      ]
    }
  ],
  "dismissal": {
    "team_member_name": "Sarah Smith"
  },
  "subject": {
    "legal_name": "Sarah Smith"
  },
  "links": {
    "self": "https://api.sandbox.routable.com/v1/companies/9f869186-7869-40bf-9b85-35d7bcb4bc60/compliance-checks",
    "company": "https://api.sandbox.routable.com/v1/companies/9f869186-7869-40bf-9b85-35d7bcb4bc60"
  }
}