Skip to main content
POST
/
v2
/
customers
/
{customer_id}
/
individual
/
attach
Attach Documents to Individual Customer V2
curl --request POST \
  --url https://sandbox.api.fin.com/v2/customers/{customer_id}/individual/attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifying_documents": [
    {
      "type": "SELFIE",
      "files": [
        {
          "uri": "/AbAcQ4hn_0652746727637.pdf"
        }
      ]
    },
    {
      "type": "DRIVERS_LICENSE",
      "number": "DL987654321",
      "country": "USA",
      "state": "US-CA",
      "issue_date": "2019-06-01",
      "expiry_date": "2029-06-01",
      "files": [
        {
          "side": "FRONT",
          "uri": "/AbAcQ4hn_0652746727638.pdf"
        },
        {
          "side": "BACK",
          "uri": "/XyZ123mn_0652746727639.pdf"
        }
      ]
    }
  ],
  "address_documents": [
    {
      "type": "BANK_STATEMENT",
      "country": "USA",
      "files": [
        {
          "uri": "/PoAdef45_0652746727640.pdf"
        }
      ]
    }
  ],
  "tos_policies_value": "e9414388-fbdf-4407-b5c2-bc39eae3645b"
}
'
{
  "data": {
    "customer_id": "55bd6b4e-c20a-4cc8-9535-91d5557a67d9"
  },
  "meta": null
}
  • Upload files first using the Upload document endpoint to obtain the URIs needed for the files arrays, then reference them here.
  • The tos_policies_value should be parsed from the tos_policies_url query parameter returned from the Create Individual Customer V2 endpoint.

Prerequisites

The customer must satisfy customer_type = INDIVIDUAL, api_version = v2, and a customer_status of INCOMPLETE or ACTION_REQUIRED. Any other state returns 403. Only one attach can be in flight per customer; a second concurrent attach returns 409.

Identity Document Side Requirements

TypeFilesSides
PASSPORT1Side optional
NATIONAL_ID2One FRONT and one BACK
DRIVERS_LICENSE2One FRONT and one BACK
RESIDENCE_PERMIT2One FRONT and one BACK
SELFIE1Side optional

Key Rules

  • At most one non-SELFIE document may be included in identifying_documents. To switch the primary document type, re-attach with the new type.
  • state is required when type is DRIVERS_LICENSE and country is USA. It is optional for a DRIVERS_LICENSE issued elsewhere, and forbidden for PASSPORT, NATIONAL_ID, and RESIDENCE_PERMIT.
  • Exactly one address_documents entry is required.
  • File URIs must be unique across the entire request (SELFIE files excluded) and must belong to this customer.
  • A SELFIE entry may be required depending on your client configuration. When required, include exactly one SELFIE entry carrying at least one file.

Authorizations

Authorization
string
header
required

Bearer token authentication. Obtain token from Issue a Token endpoint

Path Parameters

customer_id
string<uuid>
required

Unique identifier for the individual customer

Body

application/json
identifying_documents
object[]
required

Government-issued identity documents. Include at most one non-SELFIE primary document (PASSPORT, NATIONAL_ID, DRIVERS_LICENSE, or RESIDENCE_PERMIT) plus an optional SELFIE entry. NATIONAL_ID, DRIVERS_LICENSE, and RESIDENCE_PERMIT require both FRONT and BACK files.

Minimum array length: 1
address_documents
object[]
required

Proof of address. Exactly one entry is required.

Required array length: 1 element
tos_policies_value
string
required

Parsed from the tos_policies_value query parameter in the tos_policies_url returned by POST /v2/customers/individual. Signifies the customer has accepted the Terms of Service.

Example:

"e9414388-fbdf-4407-b5c2-bc39eae3645b"

Response

Request validated and queued for asynchronous processing

data
object
meta
object
Example:

null