Compliance forms
The forms a broker emails a client to fill in and sign: the PEP declaration and consent forms.
List the consent forms on a deal
The consent forms emailed to the borrowers on the deal, newest first. A borrower signs a form by typing their name, and the signature records a consent on the deal in consent_id. A form has no updated_at, so this list takes no updated_since: filter by status to find the forms that came back. A credit consent sent on the brokerage's own uploaded form is a signing request, not a form, and is not listed.
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
contact_idOnly the forms sent to this borrower.
scopeOnly the forms that ask for this consent.
statusOnly the forms with this status.
List the consent forms on a deal › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Send a consent form
Emails a borrower on the deal a form to sign their consent for one scope, as the deal's Compliance tab does. The email goes out now, from the broker's connected email, with a link that works for 30 days. For credit_pull, when the brokerage uploaded its own credit consent form, the borrower gets that form to sign in an intake instead, and kind is intake. A key with the no_sending limit cannot use this endpoint. Supports Idempotency-Key.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Send a consent form › Request Body
contact_idThe borrower to ask. The borrower must be on the deal.
scopeWhat to ask the borrower to authorize. For credit_pull, when the brokerage uploaded its own credit consent form in BrokerPlus, the borrower gets that form to sign instead, as in BrokerPlus.
email^(?:[A-Za-z0-9_'+\-]…The address to send it to. When it differs from the borrower's email, it replaces that email, as in BrokerPlus.
messageA note from the broker in the email. 2000 characters at most.
Send a consent form › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a consent form
One consent form on the deal: who it went to, the words it asks the borrower to agree to, and its status.
path Parameters
idResource id.
formIdResource id.
Retrieve a consent form › Responses
Success
successAlways true on a successful response.
The requested record.
List PEP forms
The politically exposed person (PEP) declaration forms sent to the broker's clients, newest first. A form has no updated_at, so this list takes no updated_since: filter by status to find the forms that came back.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
contact_idOnly the forms sent to this contact.
deal_idOnly the forms sent from this deal.
statusOnly the forms with this status.
List PEP forms › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Send a PEP form
Emails a client the PEP declaration form from BrokerPlus, now. The client gets a link to the form from the broker's connected email. The link works for 30 days. Only the broker assigned to the client, or an admin, can send the form. The response is the form. A key with the no_sending limit cannot use this endpoint. Supports Idempotency-Key.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Send a PEP form › Request Body
contact_idThe client to send the form to. The client needs a first name, a last name, and an email address on the contact.
application_numberAn application number to print on the form, if any. 100 characters at most.
Send a PEP form › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a PEP form
One PEP declaration form: who it went to, its status, and the client's answers. Only the broker who sent the form and a compliance reviewer get the detailed answers in answers.
path Parameters
idResource id.
Retrieve a PEP form › Responses
Success
successAlways true on a successful response.
The requested record.