Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Create an Identity for a Buyer

All fields for a buyer's Identity are optional. Do not pass the business_type field as that indicates that the Identity should be treated as a Merchant .

Copy
Copied
curl https://finix.sandbox-payments-api.com/identities \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
    -d '
	{
	    "entity": {
	        "phone": "7145677613",
	        "first_name": "John",
	        "last_name": "Smith",
	        "email": "finix_example@finix.com",
	        "personal_address": {
	            "city": "San Mateo",
	            "country": "USA",
	            "region": "CA",
	            "line2": "Apartment 7",
	            "line1": "741 Douglass St",
	            "postal_code": "94114"
	        }
	    },
	    "tags": {
	        "key": "value"
	    }
	}'

Example Response:

Copy
Copied
{
  "id" : "IDmkYECDu5toxsXxmnbQvNdi",
  "created_at" : "2022-10-07T20:41:38.25Z",
  "updated_at" : "2022-10-07T20:41:38.25Z",
  "application" : "APgPDQrLD52TYvqazjHJJchM",
  "entity" : {
    "amex_mid" : null,
    "annual_card_volume" : 0,
    "business_address" : null,
    "business_name" : null,
    "business_phone" : null,
    "business_tax_id_provided" : false,
    "business_type" : null,
    "default_statement_descriptor" : null,
    "discover_mid" : null,
    "dob" : null,
    "doing_business_as" : null,
    "email" : "finix_example@finix.com",
    "first_name" : "John",
    "has_accepted_credit_cards_previously" : false,
    "incorporation_date" : null,
    "last_name" : "Smith",
    "max_transaction_amount" : 0,
    "mcc" : null,
    "ownership_type" : null,
    "personal_address" : {
      "line1" : "741 Douglass St",
      "line2" : "Apartment 7",
      "city" : "San Mateo",
      "region" : "CA",
      "postal_code" : "94114",
      "country" : "USA"
    },
    "phone" : "7145677613",
    "principal_percentage_ownership" : null,
    "short_business_name" : null,
    "tax_authority" : null,
    "tax_id_provided" : false,
    "title" : null,
    "url" : null
  },
  "tags" : {
    "key" : "value"
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi"
    },
    "verifications" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi/verifications"
    },
    "merchants" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi/merchants"
    },
    "settlements" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi/settlements"
    },
    "authorizations" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi/authorizations"
    },
    "transfers" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi/transfers"
    },
    "payment_instruments" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi/payment_instruments"
    },
    "associated_identities" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi/associated_identities"
    },
    "disputes" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDmkYECDu5toxsXxmnbQvNdi/disputes"
    },
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
    }
  }
}

HTTP Request

POST https://finix.sandbox-payments-api.com/identities

Request Arguments

Field Type Description
city string, optional City (max 20 characters)
country string, optional 3-Letter Country code
email string, optional Email address
first_name string, optional First name
last_name string, optional Last name
line1 string, optional First line of the address (max 35 characters)
line2 string, optional Second line of the address (max 35 characters)
phone string, optional Phone number
postal_code string, optional Zip or Postal code (max 7 characters)
region string, optional 2-letter State code
tags object, optional Key value pair for annotating custom metadata (e.g. order numbers)