Private API Reference

Proof of Authorization Request Submissions

Information submitted in response to a proof of authorization request. Per Nacha’s guidance on proof of authorization, the originator must ensure that the authorization complies with applicable legal requirements, is readily identifiable as an authorization, and has clear and readily understandable terms.

The Proof of Authorization Request Submission object

{
  "additional_evidence_files": [
    {
      "file_id": "file_makxrc67oh9l6sg7w9yc"
    }
  ],
  "authorization_terms": "I agree to the terms.",
  "authorized_at": "2020-01-31T23:59:59Z",
  "authorizer_company": "National Phonograph Company",
  "authorizer_email": "user@example.com",
  "authorizer_ip_address": "123.45.67.89",
  "authorizer_name": "Ian Crease",
  "created_at": "2020-01-31T23:59:59Z",
  "customer_has_been_offboarded": false,
  "id": "proof_of_authorization_request_submission_uqhqroiley7n0097vizn",
  "idempotency_key": null,
  "originator_contact_information": "user@example.com",
  "originator_name": "National Phonograph Company",
  "proof_of_authorization_request_id": "proof_of_authorization_request_iwp8no25h3rjvil6ad3b",
  "status": "pending_review",
  "type": "proof_of_authorization_request_submission",
  "updated_at": "2020-01-31T23:59:59Z",
  "validated_account_ownership_via_credential": false,
  "validated_account_ownership_with_account_statement": false,
  "validated_account_ownership_with_microdeposit": true
}

Attributes

additional_evidence_files

array

Files containing additional evidence.

authorization_terms

string

Terms of authorization.

authorized_at

string

Time of authorization.

authorizer_company

string

Nullable

Company of the authorizer.

authorizer_email

string

Nullable

Email of the authorizer.

authorizer_ip_address

string

Nullable

IP address of the authorizer.

authorizer_name

string

Nullable

Name of the authorizer.

created_at

string

The time the Proof of Authorization Request Submission was created.

customer_has_been_offboarded

boolean

Nullable

Whether the customer has been offboarded.

string

The Proof of Authorization Request Submission identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

originator_contact_information

string

Nullable

Contact information for the originator.

originator_name

string

Nullable

Name of the originator.

proof_of_authorization_request_id

string

ID of the proof of authorization request.

More about Proof of Authorization Requests.

status

enum

Status of the proof of authorization request submission.

type

string

A constant representing the object’s type. For this resource it will always be proof_of_authorization_request_submission.

updated_at

string

The time the Proof of Authorization Request Submission was last updated.

validated_account_ownership_via_credential

boolean

Nullable

Whether account ownership was validated via credential (for instance, Plaid).

validated_account_ownership_with_account_statement

boolean

Nullable

Whether account ownership was validated with an account statement.

validated_account_ownership_with_microdeposit

boolean

Nullable

Whether account ownership was validated with microdeposit.

List Proof of Authorization Request Submissions

curl \
  --url "${INCREASE_URL}/proof_of_authorization_request_submissions?proof_of_authorization_request_id=proof_of_authorization_request_iwp8no25h3rjvil6ad3b" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Proof of Authorization Request Submission object */ },
    { /* Proof of Authorization Request Submission object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

proof_of_authorization_request_id

string

ID of the proof of authorization request.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

More parameters

cursor

string

limit

integer

Submit Proof of Authorization

curl -X "POST" \
  --url "${INCREASE_URL}/proof_of_authorization_request_submissions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "additional_evidence_file_id": "file_makxrc67oh9l6sg7w9yc",
    "authorization_terms": "I agree to the terms of service.",
    "authorized_at": "2020-01-31T23:59:59Z",
    "authorizer_company": "National Phonograph Company",
    "authorizer_email": "user@example.com",
    "authorizer_name": "Ian Crease",
    "customer_has_been_offboarded": true,
    "originator_contact_information": "user@example.com",
    "originator_name": "National Phonograph Company",
    "proof_of_authorization_request_id": "proof_of_authorization_request_iwp8no25h3rjvil6ad3b",
    "validated_account_ownership_via_credential": true,
    "validated_account_ownership_with_account_statement": true,
    "validated_account_ownership_with_microdeposit": true
  }'

Parameters

additional_evidence_file_id

string

File containing additional evidence.

More about Files.

authorization_terms

string

Required

Terms of authorization.

Between 1 and 2048 characters

authorized_at

string

Required

Time of authorization.

authorizer_company

string

Company of the authorizer.

Between 1 and 200 characters

authorizer_email

string

Required

Email of the authorizer.

Between 1 and 200 characters

authorizer_ip_address

string

IP address of the authorizer.

Between 1 and 200 characters

authorizer_name

string

Required

Name of the authorizer.

Between 1 and 200 characters

customer_has_been_offboarded

boolean

Required

Whether the customer has been offboarded or suspended.

originator_contact_information

string

Required

Contact information of the originator.

Between 1 and 200 characters

originator_name

string

Required

Name of the originator.

Between 1 and 200 characters

proof_of_authorization_request_id

string

Required

ID of the proof of authorization request.

More about Proof of Authorization Requests.

validated_account_ownership_via_credential

boolean

Required

Whether the account ownership was validated via credential (e.g. Plaid).

validated_account_ownership_with_account_statement

boolean

Required

Whether the account ownership was validated with an account statement.

validated_account_ownership_with_microdeposit

boolean

Required

Whether the account ownership was validated with a microdeposit.

Retrieve a Proof of Authorization Request Submission

curl \
  --url "${INCREASE_URL}/proof_of_authorization_request_submissions/proof_of_authorization_request_submission_uqhqroiley7n0097vizn" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

proof_of_authorization_request_submission_id

string

Required

The identifier of the Proof of Authorization Request Submission.