increase-test
POST/intrafi_account_enrollments/{intrafi_account_enrollment_id}/unenroll

Unenroll an account from IntraFi

Unenrolls an account from IntraFi using its enrollment identifier. Use intrafi_account_enrollment_id to select the enrollment; the response returns the enrollment with its updated status.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
intrafi_account_enrollment_idstringrequired
The identifier of the IntraFi account enrollment to remove from IntraFi.

3 status codes
200Returns the IntraFi account enrollment, including its identifier, account, status, creation time, IntraFi identifier, and contact email address.
account_idstringrequired
The identifier of the Increase Account being swept into the network.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the enrollment was created.
email_addressstringrequired
The contact email for the account owner, to be shared with IntraFi.
idstringrequired
The identifier of this enrollment at IntraFi.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
intrafi_idstringrequired
The identifier of the account in IntraFi's system. This identifier will be printed on any IntraFi statements or documents.
statusstringrequired
The status of the account in the network. An account takes about one business day to go from `pending_enrolling` to `enrolled`.
Allowed:pending_enrollingenrolledpending_unenrollingunenrolledrequires_attention
typestringrequired
A constant representing the object's type. For this resource it will always be `intrafi_account_enrollment`.
Allowed:intrafi_account_enrollment
4XXReturned when the request cannot be completed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

The intrafi_account_enrollment_id path parameter must identify the IntraFi account enrollment to unenroll.