Update an Identity

attention

This API is available for Finix Flex and Finix Core customers.

attention

The tax_id and business_tax_id fields cannot be updated. If either field was input incorrectly, create a new Identity resource.

Update the information of a previously created Identity. In the case of Merchant accounts, this API request does not update this information on the underlying processor. To update the Merchant's information on the underlying processor, you must update the Merchant on the processor.

Copy
Copied
curl https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG \
    -H "Content-Type: application/vnd.json+api" \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
    -X PUT \
    -d '
	{
	    "tags": {
	        "key": "value_2"
	    },
	    "entity": {
	        "business_phone": "+1 (408) 756-4497",
	        "first_name": "Bernard",
	        "last_name": "Jones",
	        "title": "CTO",
	        "dob": {
	            "year": 1988,
	            "day": 2,
	            "month": 5
	        },
	        "ownership_type": "PRIVATE",
	        "has_accepted_credit_cards_previously": true,
	        "mcc": "0742",
	        "phone": "7144177878",
	        "business_tax_id": "123456789",
	        "max_transaction_amount": 1200000,
	        "principal_percentage_ownership": 50,
	        "doing_business_as": "Bobs Burgers",
	        "annual_card_volume": 12000000,
	        "default_statement_descriptor": "Bobs Burgers",
	        "url": "www.BobsBurgers.com",
	        "business_name": "Bobs Burgers",
	        "personal_address": {
	            "city": "San Diego",
	            "country": "USA",
	            "region": "CA",
	            "line2": "Apartment 2",
	            "line1": "712 Douglass St",
	            "postal_code": "94194"
	        },
	        "email": "user@example.org",
	        "tax_id": "999999999"
	    }
	}'

Example Response:

Copy
Copied
{
  "id" : "IDpYDM7J9n57q849o9E9yNrG",
  "application" : "APgPDQrLD52TYvqazjHJJchM",
  "entity" : {
    "title" : "CTO",
    "first_name" : "Bernard",
    "last_name" : "Jones",
    "email" : "user@example.org",
    "business_name" : "Bobs Burgers",
    "business_type" : "INDIVIDUAL_SOLE_PROPRIETORSHIP",
    "doing_business_as" : "Bobs Burgers",
    "phone" : "7144177878",
    "business_phone" : "+1 (408) 756-4497",
    "personal_address" : {
      "line1" : "712 Douglass St",
      "line2" : "Apartment 2",
      "city" : "San Diego",
      "region" : "CA",
      "postal_code" : "94194",
      "country" : "USA"
    },
    "business_address" : {
      "line1" : "741 Douglass St",
      "line2" : "Apartment 8",
      "city" : "San Mateo",
      "region" : "CA",
      "postal_code" : "94114",
      "country" : "USA"
    },
    "mcc" : "0742",
    "dob" : {
      "day" : 2,
      "month" : 5,
      "year" : 1988
    },
    "max_transaction_amount" : 1200000,
    "amex_mid" : null,
    "discover_mid" : null,
    "url" : "www.BobsBurgers.com",
    "annual_card_volume" : 12000000,
    "has_accepted_credit_cards_previously" : true,
    "incorporation_date" : {
      "day" : 27,
      "month" : 6,
      "year" : 1978
    },
    "principal_percentage_ownership" : 50,
    "short_business_name" : null,
    "ownership_type" : "PRIVATE",
    "tax_authority" : null,
    "tax_id_provided" : true,
    "business_tax_id_provided" : true,
    "default_statement_descriptor" : "Bobs Burgers"
  },
  "tags" : {
    "key" : "value_2"
  },
  "created_at" : "2022-01-27T07:36:52.11Z",
  "updated_at" : "2022-01-27T07:42:46.13Z",
  "additional_underwriting_data" : {
    "annual_ach_volume" : 200000,
    "average_ach_transfer_amount" : 200000,
    "average_card_transfer_amount" : 200000,
    "business_description" : "SB3 vegan cafe",
    "card_volume_distribution" : {
      "card_present_percentage" : 30,
      "ecommerce_percentage" : 60,
      "mail_order_telephone_order_percentage" : 10
    },
    "credit_check_allowed" : true,
    "credit_check_ip_address" : "42.1.1.113",
    "credit_check_timestamp" : "2021-04-28T16:42:55Z",
    "credit_check_user_agent" : "Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)",
    "merchant_agreement_accepted" : true,
    "merchant_agreement_ip_address" : "42.1.1.113",
    "merchant_agreement_timestamp" : "2021-04-28T16:42:55Z",
    "merchant_agreement_user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)",
    "refund_policy" : "MERCHANDISE_EXCHANGE_ONLY",
    "volume_distribution_by_business_type" : {
      "business_to_business_volume_percentage" : 100,
      "business_to_consumer_volume_percentage" : 0,
      "consumer_to_consumer_volume_percentage" : 0,
      "other_volume_percentage" : 0,
      "person_to_person_volume_percentage" : 0
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
    },
    "verifications" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/verifications"
    },
    "merchants" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/merchants"
    },
    "settlements" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/settlements"
    },
    "authorizations" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/authorizations"
    },
    "transfers" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/transfers"
    },
    "payment_instruments" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/payment_instruments"
    },
    "associated_identities" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/associated_identities"
    },
    "disputes" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG/disputes"
    },
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
    }
  }
}

HTTP Request

PUT https://finix.sandbox-payments-api.com/identities/:IDENTITY_ID

Business-specific Request Arguments

Field Type Description
business_address object, required Primary address for the legal entity (Full description of child attributes below)
business_name string, required Merchant's full legal business name (If INDIVIDUAL_SOLE_PROPRIETORSHIP, please input first name, Full legal last name and middle initial; max 120 characters)
business_phone string, required Customer service phone number where the merchant can be reached (max 10 characters)
business_tax_id string, required Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN) or if the business_type is INDIVIDUAL_SOLE_PROPRIETORSHIP and a Tax ID is not available, the principal's Social Security Number (SSN)
business_type string, required Please select one of the following values: INDIVIDUAL_SOLE_PROPRIETORSHIP, CORPORATION, LIMITED_LIABILITY_COMPANY, PARTNERSHIP, ASSOCIATION_ESTATE_TRUST, TAX_EXEMPT_ORGANIZATION, INTERNATIONAL_ORGANIZATION, GOVERNMENT_AGENCY
doing_business_as string, required Alternate name of the business. If no other name is used please use the same value for business_name (max 60 characters)
incorporation_date object, required Date company was founded (See below for a full list of the child attributes)
ownership_type string, required Values can be either PUBLIC to indicate a publicly traded company or PRIVATE for privately held businesses
url string, required Merchant's publicly available website (max 100 characters)

Principal-specific Request Arguments

(i.e. authorized representative or primary contact responsible for the account)

Field Type Description
dob object, required Principal's date of birth (Full description of child attributes below)
email string, required Principal's email address where they can be reached (max 100 characters)
first_name string, required Full legal first name of the merchant's principal representative (max 20 characters)
last_name string, required Full legal last name of the merchant's principal representative (max 20 characters)
personal_address object, required Principal's personal home address. This field is used for identity verification purposes (Full description of child attributes below)
phone string, required Principal's phone number (max 10 characters)
principal_percentage_ownership integer, required Percentage of company owned by the principal (min 0; max 100)
tax_id string, required Nine digit Social Security Number (SSN) for the principal
title string, required Principal's corporate title or role (i.e. Chief Executive Officer, CFO, etc.; max 60 characters)

Processing-specific Request Arguments

Field Type Description
annual_card_volume integer, required Approximate annual credit card sales expected to be processed in cents by this merchant (max 19 characters)
default_statement_descriptor string, required Billing descriptor displayed on the buyer's bank or card statement (Length must be between 1 and 20 characters)
has_accepted_credit_cards_previously boolean, optional Defaults to false if not passed
max_transaction_amount integer, required Maximum amount that can be transacted for a single transaction in cents (max 12 characters)
mcc string, required Merchant Category Code (MCC) that this merchant will be classified under

Address-object Request Arguments

Field Type Description
city string, required City (max 20 characters)
country string, optional 3-Letter Country code
line1 string, optional First line of the address (max 35 characters)
line2 string, optional Second line of the address (max 35 characters)
postal_code string, optional Zip or Postal code (max 7 characters)
region string, optional 2-letter State code

Incorporation Date-object Request Arguments

Field Type Description
day integer, required Day business was incorporated (between 1 and 31)
month integer, required Month business was incorporated (between 1 and 12)
year integer, required Year business was incorporated (4-digit)

DOB-object Request Arguments

Field Type Description
day integer, required Day of birth (between 1 and 31)
month integer, required Month of birth (between 1 and 12)
year integer, required Year of birth (4-digit)