healthCheck

Overview

This mutation performs general maintenance on the account including: resending uploadedId to AFEX if failed, cleaning up expired payment requests with no recipient, fetch most recent client status from AFEX, and check if 90 minutes have passed for ACH setup for all bank accounts, and returns the success result.

Special Considerations

  • Query does not take any inputs

Inputs

N/A

Returns

Promise<SuccessResult>

A promise containing the following object / data:

message: string

Example

Running this mutation:

mutation {
  healthCheck {
    message
  }
}

Gives us:

{
  "data": {
    "healthCheck": {
      "message" : "Success"
    }
  }
}

Common Errors

When running this mutation some of the common errors encountered include:

  • Error updating ID for client (I-4415)

    • Error occurred in reuploading the ID, please try again

  • You can only healthCheck on pending and verified accounts. (I-4408)

    • The account is either not set up, deactivated, or forbidden
← PrevioustestWebhook →