Entity Errors - Method API Docs

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.

`RESTRICTED_ENTITY_DETAILS`

The Entity’s information does not match the restrictions set for your organization.

`ENTITY_CONSENT_ALREADY_WITHDRAWN`

Consent for this Entity has already been withdrawn.

`ENTITY_CONSENT_ALREADY_GRANTED`

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_DISABLED`

Disabled Entities cannot be updated.

`ENTITY_UPDATE_INVALID`

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

`ENTITY_CAPABILITY_UNAVAILABLE`

The Entity must have data:retrieve as an available capability.

`ENTITY_PHONE_VERIFICATION_INVALID_CODE`

The phone verification code provided is invalid.

`ENTITY_UPDATE_METADATA_SIZE_EXCEEDED`

The maximum metadata object size of 1KB was exceeded.

`INVALID_ENTITY_DOB`

The date of birth is invalid. Date of birth cannot be in the future.

`INVALID_ENTITY_STATUS_FOR_REFRESH_CAPABILITY`

The Entity must be in active status.

Auth session request errors

The following sub_type values are returned by the /entities/{ent_id}/auth_session endpoints.

`ENTITY_AUTH_SESSION_COMPLETED`

This Entity already has a completed auth session.

`ENTITY_AUTH_SESSION_CREDIT_FREEZE`

The Entity is not available for non-KBA authentication due to a credit freeze. Re-attempt the auth session using the KBA authentication flow.

`ENTITY_AUTH_SESSION_FRAUD`

The Entity is not available for non-KBA authentication. Re-attempt the auth session using the KBA authentication flow.

`ENTITY_AUTH_SESSION_INVALID_ATTEMPT`

The authentication attempt is invalid. One more invalid attempt locks the session.

`ENTITY_AUTH_SESSION_LOCKED`

The auth session is locked due to invalid attempts.

`ENTITY_AUTH_SESSION_MISSING`

This Entity has not initiated an auth session.

`ENTITY_AUTH_SESSION_NOT_FOUND`

The Entity is not available due to an unsuccessful match with the information provided.

`INVALID_ENTITY_AUTH_ANSWERS`

An auth session answer is missing or invalid.

`INVALID_ENTITY_AUTH_QUESTIONS`

An auth session question is missing or invalid.

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_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": 12003,
  "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.

`12004 – ENTITY_CONSENT_WITHDRAWN`

The Entity was disabled due to consent being withdrawn.

Causes

The Entity has withdrawn consent.

{
  "type": "ENTITY_DISABLED",
  "code": 12004,
  "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.

`12005 – 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": 12005,
  "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.

​Request Errors

​INVALID_REQUEST

​NOT_FOUND

​RESTRICTED_ENTITY_DETAILS

​ENTITY_CONSENT_ALREADY_WITHDRAWN

​ENTITY_CONSENT_ALREADY_GRANTED

​ENTITY_HAS_PAYMENTS_IN_PROGRESS

​ENTITY_INVALID_SSN

​ENTITY_INVALID_SSN4

​ENTITY_CREDIT_SCORE_NOT_FOUND

​MAX_ENTITY_METADATA_SIZE_EXCEEDED

​ENTITY_UPDATE_DISABLED

​ENTITY_UPDATE_INVALID

​ENTITY_CAPABILITY_UNAVAILABLE

​ENTITY_PHONE_VERIFICATION_INVALID_CODE

​ENTITY_UPDATE_METADATA_SIZE_EXCEEDED

​INVALID_ENTITY_DOB

​INVALID_ENTITY_STATUS_FOR_REFRESH_CAPABILITY

​Auth session request errors

​ENTITY_AUTH_SESSION_COMPLETED

​ENTITY_AUTH_SESSION_CREDIT_FREEZE

​ENTITY_AUTH_SESSION_FRAUD

​ENTITY_AUTH_SESSION_INVALID_ATTEMPT

​ENTITY_AUTH_SESSION_LOCKED

​ENTITY_AUTH_SESSION_MISSING

​ENTITY_AUTH_SESSION_NOT_FOUND

​INVALID_ENTITY_AUTH_ANSWERS

​INVALID_ENTITY_AUTH_QUESTIONS

​Resource Errors

​12001 – ENTITY_UNAUTHORIZED_PAYMENT

​Causes

​Resolution

​12002 – ENTITY_INVALID_DETAILS

​Causes

​Resolution

​12003 – ENTITY_SSN_MISMATCH

​Causes

​Resolution

​12004 – ENTITY_CONSENT_WITHDRAWN

​Causes

​Resolution

​12005 – ENTITY_PENDING_KYC_REVIEW

​Causes

​Resolution

Request Errors

`INVALID_REQUEST`

`NOT_FOUND`

`RESTRICTED_ENTITY_DETAILS`

`ENTITY_CONSENT_ALREADY_WITHDRAWN`

`ENTITY_CONSENT_ALREADY_GRANTED`

`ENTITY_HAS_PAYMENTS_IN_PROGRESS`

`ENTITY_INVALID_SSN`

`ENTITY_INVALID_SSN4`

`ENTITY_CREDIT_SCORE_NOT_FOUND`

`MAX_ENTITY_METADATA_SIZE_EXCEEDED`

`ENTITY_UPDATE_DISABLED`

`ENTITY_UPDATE_INVALID`

`ENTITY_CAPABILITY_UNAVAILABLE`

`ENTITY_PHONE_VERIFICATION_INVALID_CODE`

`ENTITY_UPDATE_METADATA_SIZE_EXCEEDED`

`INVALID_ENTITY_DOB`

`INVALID_ENTITY_STATUS_FOR_REFRESH_CAPABILITY`

Auth session request errors

`ENTITY_AUTH_SESSION_COMPLETED`

`ENTITY_AUTH_SESSION_CREDIT_FREEZE`

`ENTITY_AUTH_SESSION_FRAUD`

`ENTITY_AUTH_SESSION_INVALID_ATTEMPT`

`ENTITY_AUTH_SESSION_LOCKED`

`ENTITY_AUTH_SESSION_MISSING`

`ENTITY_AUTH_SESSION_NOT_FOUND`

`INVALID_ENTITY_AUTH_ANSWERS`

`INVALID_ENTITY_AUTH_QUESTIONS`

Resource Errors

`12001 – ENTITY_UNAUTHORIZED_PAYMENT`

Causes

Resolution

`12002 – ENTITY_INVALID_DETAILS`

Causes

Resolution

`12003 – ENTITY_SSN_MISMATCH`

Causes

Resolution

`12004 – ENTITY_CONSENT_WITHDRAWN`

Causes

Resolution

`12005 – ENTITY_PENDING_KYC_REVIEW`

Causes

Resolution