Skip to content

Income verification and Insights #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
IsraelWebDev wants to merge 2 commits into
base: master
Choose a base branch
from
+54 −3
Open

Income verification and Insights #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
418fce0
Update Tokens.php
IsraelWebDev Oct 9, 2023
c448664
Update Items.php
IsraelWebDev Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion src/Resources/Items.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,38 @@ public function getIncome(string $access_token): object
$this->paramsWithClientCredentials($params)
);
}
}

/**
* Get an Item's income information.
*
* @param array $params for user and employer
* @return object with precheck_id and confidence
*/
public function getIncomePrecheck(array $params = []): object
{
/*$params = [
"access_token" => $access_token
];*/

return $this->doRequest(
$this->buildRequest("post", "income/verification/precheck", $this->clientCredentials($params))
);
}

/**
* Get an Item's income information.
*
* @param string $access_token
* @return object
*/
public function getIncomePaystubs(string $access_token): object
{
$params = [
"access_token" => $access_token
];

return $this->doRequest(
$this->buildRequest("post", "income/verification/paystubs/get", $this->clientCredentials($params))
);
}
}
21 changes: 19 additions & 2 deletions src/Resources/Tokens.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ class Tokens extends AbstractResource
* @param string|null $payment_id
* @param string|null $institution_id
* @param array|null $auth
* @param string|null $precheck_id
* @param int|null $income_insight_days
* @throws PlaidRequestException
* @return object
*/
Expand All @@ -42,7 +44,9 @@ public function create(
?string $android_package_name = null,
?string $payment_id = null,
?string $institution_id = null,
?array $auth = null): object {
?array $auth = null,
?string $precheck_id = null,
?int $income_insight_days = null): object {

$params = [
"client_name" => $client_name,
Expand Down Expand Up @@ -90,6 +94,19 @@ public function create(
$params["auth"] = $auth;
}

if( $precheck_id ){
$params["income_verification"] = [
"precheck_id" => $precheck_id
];
}

if(in_array("assets", $products) && ($income_insight_days !== null)){
$params["asset_report"] = [
"bank_income_insights_enabled" => $income_insight_days > 0,
"days_requested" => $income_insight_days
];
}

return $this->sendRequest(
"post",
"link/token/create",
Expand All @@ -116,4 +133,4 @@ public function get(string $link_token): object
$this->paramsWithClientCredentials($params)
);
}
}
}