Create a Contact

Creates a contact by passing the required contact information.
Contacts
Create a Contact
 last updated: 
November 22, 2022

ENDPOINT

  1. POST /v1/contact

REQUEST

  1. {
  2.     "accountId": "{{accountId}}",
  3.     "name": "Bright Light LLC",
  4.     "email": "dwightlight@gmail.com",
  5.     "phone": "+18467051332",
  6.     "intrabank": {
  7.         "accountNumber": "9990001149517700",
  8.         "accountId": "acc-...."
  9.     },
  10.     "ach": {
  11.         "accountNumber": "1098324502",
  12.         "routingNumber": "121042882",
  13.         "accountType": "businessChecking",
  14.         "bankName": "Wells Fargo"
  15.     },
  16.     "wire": {
  17.         "domestic": {
  18.             "accountNumber": "1098324502",
  19.             "routingNumber": "121000248",
  20.             "accountType": "businessChecking",
  21.             "bankName": "Wells Fargo",
  22.             "address": {
  23.                 "addressType": "wire",
  24.                 "line1": "123 Main St",
  25.                 "line2": "",
  26.                 "city": "New York",
  27.                 "state": "NY",
  28.                 "country": "US",
  29.                 "postalCode": "10001"
  30.             }
  31.         }
  32.     },
  33.     "check": {
  34.         "address": {
  35.             "addressType": "check",
  36.             "line1": "123 Main St",
  37.             "line2": "",
  38.             "city": "New York",
  39.             "state": "NY",
  40.             "country": "US",
  41.             "postalCode": "10001"
  42.         }
  43.     },
  44.     "card": {
  45.         "address": {
  46.             "addressType": "card",
  47.             "line1": "123 Main St",
  48.             "line2": "",
  49.             "city": "New York",
  50.             "state": "NY",
  51.             "country": "US",
  52.             "postalCode": "10001"
  53.         }
  54.     }
  55. }

RESPONSE

  1. {
  2.     "id": "con-ab8e4ddc-cf09-448d-aa19-f71527b8393c",
  3.     "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  4.     "name": "Bright Light LLC",
  5.     "email": "dwightlight@gmail.com",
  6.     "phone": "+18467051332",
  7.     "status": "active",
  8.     "intrabank": {
  9.         "accountNumber": "9990001149517700"
  10.     },
  11.     "ach": {
  12.         "accountNumber": "1098324502",
  13.         "routingNumber": "121042882",
  14.         "accountType": "businessChecking",
  15.         "bankName": "Wells Fargo"
  16.     },
  17.     "createdAt": "2021-12-16T05:48:21Z",
  18.     "modifiedAt": "2021-12-16T05:48:21Z",
  19.     "wire": {
  20.         "domestic": {
  21.             "accountNumber": "1098324502",
  22.             "routingNumber": "121042882",
  23.             "accountType": "businessChecking",
  24.             "bankName": "Wells Fargo",
  25.             "address": {
  26.                 "addressType": "wire",
  27.                 "line1": "123 Main St",
  28.                 "line2": "",
  29.                 "city": "New York",
  30.                 "state": "NY",
  31.                 "country": "US",
  32.                 "postalCode": "10001"
  33.             }
  34.         },
  35.         "international": null
  36.     },
  37.     "check": {
  38.         "address": {
  39.             "addressType": "check",
  40.             "line1": "123 Main St",
  41.             "line2": "",
  42.             "city": "New York",
  43.             "state": "NY",
  44.             "country": "US",
  45.             "postalCode": "10001"
  46.         }
  47.     },
  48.     "card": {
  49.         "address": {
  50.             "addressType": "card",
  51.             "line1": "123 Main St",
  52.             "line2": "",
  53.             "city": "New York",
  54.             "state": "NY",
  55.             "country": "US",
  56.             "postalCode": "10001"
  57.         }
  58.     },
  59.     "type": "others",
  60.     "metadata": null,
  61.     "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  62.     "debitCard": null
  63. }

Here is an example of an international wire sub-object:

  1. "wire": {
  2.         "international": {
  3.             "accountNumber": "920020006167511”,
  4.             "bankIdentifierType": "Swift",
  5.             "bankIdentifierCode": "AXISINBB227",
  6.             "accountType": "business",
  7.             "beneficiaryBank": "AXIS BANK LIMITED",
  8.             "beneficiaryAddress": {
  9.                 "addressType": "wire",
  10.                 "line1": "No.520, 6th Main Road, HAL 2nd Stage",
  11.                 "line2": "Indiranagar",
  12.                 "city": "BANGALORE",
  13.                 "state": "KARNATAKA",
  14.                 "country": "INDIA",
  15.                 "postalCode": "560038"
  16.             },
  17.             "beneficiaryBankAddress": {
  18.                 "addressType": "wire",
  19.                 "line1": "233 2ND MAIN SAMPIGE ROAD",
  20.                 "line2": "",
  21.                 "city": "BANGALORE",
  22.                 "state": "KARNATAKA",
  23.                 "country": "INDIA",
  24.                 "postalCode": "560003"
  25.             },
  26.             "correspondentBank": ""
  27.         }
  28.     }
  29. }