Create Book copy jobs

This API submits asynchronous copy requests that duplicate a Book and all uploaded documents to a specified recipient organization. Each request creates a job. You can monitor job status using the List Book Copy Jobs endpoint.

Supported workflows

  1. Updating existing applications: Use a prior share label on the Book you are sharing so the new docs are appended to existing Book. Prevents duplicate Books when an applicant submits additional or missing documents.
  2. Renewal/re-engagement: This workflows support two approaches. You can create a new Book by using either a new shared Book label to initiate a new application with receivers, or a previously used shared Book label to associate the new application with an existing one. Alternatively, you can reuse an existing Book, similar to the application update workflow.

To learn more, see the Sender's guide.

👍

Suggestion

We recommend using new share labels for re-engagement and renewal applications to avoid creating confusion on the receiver's side.

📘

Note

  • This API is intended for small and medium business (SMB) funders.
  • This API supports a maximum of 50 requests per call meaning you can include up to 50 Book copy requests in a single API call. If you need to process more, split them into multiple calls.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Example of body to be sent to submit Book copy jobs.

Copy Requests
array of objects

An array of copy requests for Books to be copied to recipient organizations.

Copy Requests
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json