The employee's ID

The wallet's bank account number

The wallet's bank routing number

NOT_CREATED: A wallet has not yet been created.

CREATED: A wallet has been created.

FAILED: A failure occurred during wallet creation.

CLOSED: A wallet has been closed.

PENDING: We are attempting to create the wallet. It is not yet available for disbursing funds.

UNCLAIMED: A wallet has been created and is able to receive funds through the API, but the employee has not signed up with Branch yet.

ACTIVE: A wallet has been created for an employee and they are in control of it.

SUSPENDED: A wallet has been suspended due to fraud, or other reasons.

REVIEW: A failure occurred during wallet creation.

NOT_CREATED PENDING REVIEW CREATED UNCLAIMED ACTIVE FAILED SUSPENDED CLOSED

Basic Reason Codes:

ADDITIONAL_DOCS_REQ: Branch was not able to confirm identity with the information provided. The user will have to provide additional documentation, like a driver's license, in order to get a wallet on Branch.

FRAUD_CHECK_REQ: Branch is performing checks to ensure that the user is not linked in any way to fraudulent activity. Once finished, this user's wallet will be activated. Until then, the wallet that was created for the user will not be able to be funded in any way.

CONFIRMED_FRAUD: Branch determined this user to behave in fraudulent activities. As a result, the user will not be allowed to have a wallet on the platform. The wallet created for them will remain closed.

DENIED: For one reason or another, the user has been denied access to the platform.

ERROR: A system error occurred, please try again.

v1.01 Reason Codes:

KYC_SSN_INVALID: KYC verification failed due to invalid social security number

KYC_PII_SSN_MISMATCH: KYC verification failed due to invalid personal information (name, birthdate)

KYC_DECEASED: KYC verification failed due to person reported deceased

KYC_PO_BOX_NOT_ALLOWED: KYC verification failed due to PO Box address

KYC_ERROR: Unexpected error occurred during KYC step

ACCOUNT_SUSPENDED: Wallet account was suspended due to failed KYC fraud checks

ACCOUNT_WITH_EMAIL_EXISTS: Another Branch account already uses the same email

EMPLOYEE_NOT_FOUND: Employee was not found

EMPLOYEE_UNDER_AGE: Employee was not of the minimum age to create an account

EMPLOYEE_ALREADY_LINKED: Employee was already linked to another user account

FRAUD_CHECK_REQ ADDITIONAL_DOCS_REQ CONFIRMED_FRAUD DENIED KYC_SSN_INVALID KYC_PII_SSN_MISMATCH KYC_DECEASED KYC_PO_BOX_NOT_ALLOWED KYC_ERROR ACCOUNT_SUSPENDED ACCOUNT_WITH_EMAIL_EXISTS EMPLOYEE_NOT_FOUND EMPLOYEE_UNDER_AGE EMPLOYEE_ALREADY_LINKED ERROR

A short message explaining the reason_code field. This may or may not provide additional
context for the reason_code.

If the wallet was initiated by the organization, will be populated with a link
with which the employee can utilize to streamline onboarding.

A link to additional documentation for KYC

9 digit Employer Identification Number. Format: XXXXXXXXX

Business name for the user.