Create Counterparty

Create a new counterparty for the purpose of pulling funds into the platform or pushing out

SecurityOAuth2: OAuth2Flow

Request

header Parameters

Authorization	string OAuth bearer token (see authentication flows)
x-l2f-request-id	string Optional Unique ID per request, useful for fault resolution/diagnosis and audit.
x-l2f-idempotency-id	string Unique ID used to safely retry an operation. See idempotency section for more details.

Request Body schema: application/json

customer_id required	string The customer to which this counter party will be registered for use.
description	string Description of the counterparty.
counterparty_type required	string The type of counterparty will determine the available rails for sending or receiving funds. See the guides for more detailed explanation of counterparty types. FIAT_US
supported_rails required	Array of strings The rails required for this counterparty. Rail selection will determine data requirements. See guides for full breakdowns. Items Enum: "ACH" "FEDWIRE" "SWIFT"
required	object (CounterPartyProfileFIATUS) Details of the counter party account holder. Required fields are determined by the combination of required rails. See the API Guides for a full documented breakdown of required fields.
required	object (CounterPartyAccountFIATUS) Details of the counter party account and institution. Required fields are determined by the combination of required needed rails. See the API Guides for a full documented breakdown of required fields.
	object (CounterPartyIntermediary) Optional details of the intermediary (correspondent bank) institution when sending SWIFT payments. `SWIFT` must be added to the `support_rail` list in order to provide an intermediary

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

post/v1/counterparties

Request samples

Payload

application/json

{"customer_id": "string",
"description": "string",
"counterparty_type": "FIAT_US",
"supported_rails": ["ACH"
],
"profile": {"profile_type": "INDIVIDUAL",
"name": "string",
"email": "string",
"telephone_number": "string",
"tax_reference_number": "string",
"date_of_birth": "2019-08-24",
"address": {"unit_number": "string",
"address_line1": "string",
"address_line2": "string",
"address_line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
},
"line_of_business": "ARTS_AND_ANTIQUES",
"relationship_to_customer": "SPOUSE"
},
"account_information": {"asset_type_id": "string",
"account_number": "string",
"type": "CHECKING",
"routing_number": "string",
"swift_bic": "string",
"institution_name": "string",
"institution_address": {"unit_number": "string",
"address_line1": "string",
"address_line2": "string",
"address_line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
}
},
"intermediary_information": {"intermediary_type": "FIAT_US",
"institution_name": "string",
"institution_address": {"unit_number": "string",
"address_line1": "string",
"address_line2": "string",
"address_line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
}
}
}

Response samples

application/json

{"data": {"id": "string"
}
}