​
Request Errors

The request to the /entities/{ent_id} endpoint failed. These are the sub_type that can be returned.

​
INVALID_REQUEST

The request body failed basic validation for the specific API endpoint.

​
NOT_FOUND

The requested resource does not exist.

​
DUPLICATE_ENTITY_DETAILS

An Entity with the same details already exists.

​
INVALID_ENTITY_PHONE_NUMBER

The provided phone number is not a valid US phone number.

​
INVALID_ENTITY_EMAIL_ADDRESS

The provided email address is not a valid email address.

​
RESTRICTED_ENTITY_DETAILS

The Entity’s information does not match the restrictions set for your organization. Consent for this Entity has already been withdrawn. Consent for this entity has already been granted.

​
ENTITY_HAS_PAYMENTS_IN_PROGRESS

Consent for this entity cannot be withdrawn as it has one or more associated payments in progress.

​
ENTITY_INVALID_SSN

The provided SSN is invalid. Verify your request and try again.

​
ENTITY_INVALID_SSN4

The provided SSN4 is invalid. Verify your request and try again.

​
ENTITY_CREDIT_SCORE_NOT_FOUND

The credit score for this entity could not be found.

​
MAX_ENTITY_METADATA_SIZE_EXCEEDED

The max metadata object size of 1KB was exceeded.

​
ENTITY_UPDATE_RESTRICTED

Only Entity’s that have consented can be updated.

​
ENTITY_UPDATE_DISABLED

Disabled Entities cannot be updated.

​
ENTITY_UPDATE_INVALID

Cannot update an Entity’s field that has already been set.

​
ENTITY_UPDATE_UNSUPPORTED

This Entity cannot be updated.

​
Resource Errors

Errors set on an Entity’s error property for processes that are unsuccessful.

​
12001 – ENTITY_UNAUTHORIZED_PAYMENT

The Entity was disabled due to unauthorized payments which was reported by the FI.

​
Causes

{
  "type": "ENTITY_DISABLED",
  "code": 12001,
  "sub_type": "ENTITY_UNAUTHORIZED_PAYMENT",
  "message": "Entity was disabled due to a payment reported as unauthorized by the financial institution."
}

​
Resolution

The Entity will be disabled and all its capabilities will be removed.

​
12002 – ENTITY_INVALID_DETAILS

The Entity was disabled due to the information provided being invalid.

​
Causes

  • One or more PIIs provided were invalid.
{
  "type": "ENTITY_DISABLED",
  "code": 12002,
  "sub_type": "ENTITY_INVALID_DETAILS",
  "message": "Entity was disabled due to invalid information."
}

​
Resolution

The Entity will be disabled and no capabilities will be granted.

​
12003 – ENTITY_PENDING_KYC_REVIEW

The Entity was disabled due Method’s provider needing to review the Entity’s KYC information.

​
Causes

  • The Entity has been flagged for requiring a KYC review.
{
  "type": "ENTITY_DISABLED",
  "code": 12003,
  "sub_type": "ENTITY_PENDING_KYC_REVIEW",
  "message": "Entity was disabled due to pending KYC review."
}

​
Resolution

The Entity will be disabled and no capabilities will be granted.

​
12004 – ENTITY_SSN_MISMATCH

The Entity was disabled due to the PII provided not matching the identity the SSN belongs to.

​
Causes

  • SSN provided does not match the Entity’s identity.
{
  "type": "ENTITY_DISABLED",
  "code": 12004,
  "sub_type": "ENTITY_SSN_MISMATCH",
  "message": "Entity was disabled due to a mismatch in the provided and retrieved social security number."
}

​
Resolution

The Entity will be disabled and no capabilities will be granted.
The Entity was disabled due to consent being withdrawn.

​
Causes

  • The Entity has withdrawn consent.
{
  "type": "ENTITY_DISABLED",
  "code": 12005,
  "sub_type": "ENTITY_CONSENT_WITHDRAWN",
  "message": "Entity was disabled due to consent withdrawal."
}

​
Resolution

The Entity will be disabled and all its capabilities will be removed.