API Reference

Create a new finance request

post
https://Contact sales to enable your sandbox/finance_requests

Creates a finance request which will get converted to an account upon outlay.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create a Finance Request for account origination processes.

string

This is the ID used to identify the finance request in your system. For most use-cases, we strongly recommend using the ID from the system the request was originally created in -- for most use-cases, this is created as part of the origination system that approves a borrower. This will be the id that is used to refer to the finance request and account that is created from the finance request. Note: both strings and integers are accepted.

string
required

The ID of the existing customer this finance request is on behalf of.

string
required

The ID of the existing product for which this finance request will be created.

external_fields
object | null

A JSON object of External Fields. These should be used to provide any additional user inputted static data to Canopy to associate with the finance request.

notes
array of strings
length ≤ 100

Any notes to attach to the finance request.

notes
date-time

The Date-Time that the borrower requests the account become active.

integer

ID of the partner entity to be used for this finance request

create_account_details
object
Responses

401

Unauthorized.

403

Forbidden.

422

Invalid input

429

Too many requests.

default

Unexpected Error.

Updated 11 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago