Recurring Pull API
This is an API to request Recurring Pull Data for a particular applicant.
Note
This feature must be turned on. Please reach out to support if you would enable this feature.
API
Sandbox API
https://auth.sandbox.conductiv.co/recurring-pull
Production API
https://auth.developer.conductiv.co/recurring-pull
Get Your API Keys
Log in to the platform and find your keys.
Header
Add a header to the request with the name "X-Keys" with a value of <Key ID>:<Key Secret>
Payload
You can pass decisions for one or more applications. Do this by passing a list of requestIDs like the following:
[
"bb57f9be-5683-4818-bcd4-4a040af384b2",
"473eb6ee-50dd-4580-ba92-7de0bcae7111",
]
RequestIDs
The RequestID property corresponds to the Request ID passed to us during the token call.
If you have any other questions, please reach out to implementation@conductiv.co for help.
Webhook
You will need to set a new webhook URL for the recurring pull requests in the platform.