Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postAccountsAccountPersons
Synopsis
- postAccountsAccountPersons :: forall m. MonadHTTP m => Text -> Maybe PostAccountsAccountPersonsRequestBody -> ClientT m (Response PostAccountsAccountPersonsResponse)
- data PostAccountsAccountPersonsRequestBody = PostAccountsAccountPersonsRequestBody {
- postAccountsAccountPersonsRequestBodyAddress :: Maybe PostAccountsAccountPersonsRequestBodyAddress'
- postAccountsAccountPersonsRequestBodyAddressKana :: Maybe PostAccountsAccountPersonsRequestBodyAddressKana'
- postAccountsAccountPersonsRequestBodyAddressKanji :: Maybe PostAccountsAccountPersonsRequestBodyAddressKanji'
- postAccountsAccountPersonsRequestBodyDob :: Maybe PostAccountsAccountPersonsRequestBodyDob'Variants
- postAccountsAccountPersonsRequestBodyDocuments :: Maybe PostAccountsAccountPersonsRequestBodyDocuments'
- postAccountsAccountPersonsRequestBodyEmail :: Maybe Text
- postAccountsAccountPersonsRequestBodyExpand :: Maybe [Text]
- postAccountsAccountPersonsRequestBodyFirstName :: Maybe Text
- postAccountsAccountPersonsRequestBodyFirstNameKana :: Maybe Text
- postAccountsAccountPersonsRequestBodyFirstNameKanji :: Maybe Text
- postAccountsAccountPersonsRequestBodyGender :: Maybe Text
- postAccountsAccountPersonsRequestBodyIdNumber :: Maybe Text
- postAccountsAccountPersonsRequestBodyLastName :: Maybe Text
- postAccountsAccountPersonsRequestBodyLastNameKana :: Maybe Text
- postAccountsAccountPersonsRequestBodyLastNameKanji :: Maybe Text
- postAccountsAccountPersonsRequestBodyMaidenName :: Maybe Text
- postAccountsAccountPersonsRequestBodyMetadata :: Maybe PostAccountsAccountPersonsRequestBodyMetadata'Variants
- postAccountsAccountPersonsRequestBodyNationality :: Maybe Text
- postAccountsAccountPersonsRequestBodyPersonToken :: Maybe Text
- postAccountsAccountPersonsRequestBodyPhone :: Maybe Text
- postAccountsAccountPersonsRequestBodyPoliticalExposure :: Maybe Text
- postAccountsAccountPersonsRequestBodyRelationship :: Maybe PostAccountsAccountPersonsRequestBodyRelationship'
- postAccountsAccountPersonsRequestBodySsnLast_4 :: Maybe Text
- postAccountsAccountPersonsRequestBodyVerification :: Maybe PostAccountsAccountPersonsRequestBodyVerification'
- mkPostAccountsAccountPersonsRequestBody :: PostAccountsAccountPersonsRequestBody
- data PostAccountsAccountPersonsRequestBodyAddress' = PostAccountsAccountPersonsRequestBodyAddress' {
- postAccountsAccountPersonsRequestBodyAddress'City :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddress'Country :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddress'Line1 :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddress'Line2 :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddress'PostalCode :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddress'State :: Maybe Text
- mkPostAccountsAccountPersonsRequestBodyAddress' :: PostAccountsAccountPersonsRequestBodyAddress'
- data PostAccountsAccountPersonsRequestBodyAddressKana' = PostAccountsAccountPersonsRequestBodyAddressKana' {
- postAccountsAccountPersonsRequestBodyAddressKana'City :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKana'Country :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKana'Line1 :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKana'Line2 :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKana'PostalCode :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKana'State :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKana'Town :: Maybe Text
- mkPostAccountsAccountPersonsRequestBodyAddressKana' :: PostAccountsAccountPersonsRequestBodyAddressKana'
- data PostAccountsAccountPersonsRequestBodyAddressKanji' = PostAccountsAccountPersonsRequestBodyAddressKanji' {
- postAccountsAccountPersonsRequestBodyAddressKanji'City :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKanji'Country :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKanji'Line1 :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKanji'Line2 :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKanji'PostalCode :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKanji'State :: Maybe Text
- postAccountsAccountPersonsRequestBodyAddressKanji'Town :: Maybe Text
- mkPostAccountsAccountPersonsRequestBodyAddressKanji' :: PostAccountsAccountPersonsRequestBodyAddressKanji'
- data PostAccountsAccountPersonsRequestBodyDob'OneOf1 = PostAccountsAccountPersonsRequestBodyDob'OneOf1 {}
- mkPostAccountsAccountPersonsRequestBodyDob'OneOf1 :: Int -> Int -> Int -> PostAccountsAccountPersonsRequestBodyDob'OneOf1
- data PostAccountsAccountPersonsRequestBodyDob'Variants
- data PostAccountsAccountPersonsRequestBodyDocuments' = PostAccountsAccountPersonsRequestBodyDocuments' {
- postAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization :: Maybe PostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization'
- postAccountsAccountPersonsRequestBodyDocuments'Passport :: Maybe PostAccountsAccountPersonsRequestBodyDocuments'Passport'
- postAccountsAccountPersonsRequestBodyDocuments'Visa :: Maybe PostAccountsAccountPersonsRequestBodyDocuments'Visa'
- mkPostAccountsAccountPersonsRequestBodyDocuments' :: PostAccountsAccountPersonsRequestBodyDocuments'
- data PostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization' = PostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization' {}
- mkPostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization' :: PostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization'
- data PostAccountsAccountPersonsRequestBodyDocuments'Passport' = PostAccountsAccountPersonsRequestBodyDocuments'Passport' {}
- mkPostAccountsAccountPersonsRequestBodyDocuments'Passport' :: PostAccountsAccountPersonsRequestBodyDocuments'Passport'
- data PostAccountsAccountPersonsRequestBodyDocuments'Visa' = PostAccountsAccountPersonsRequestBodyDocuments'Visa' {}
- mkPostAccountsAccountPersonsRequestBodyDocuments'Visa' :: PostAccountsAccountPersonsRequestBodyDocuments'Visa'
- data PostAccountsAccountPersonsRequestBodyMetadata'Variants
- data PostAccountsAccountPersonsRequestBodyRelationship' = PostAccountsAccountPersonsRequestBodyRelationship' {
- postAccountsAccountPersonsRequestBodyRelationship'Director :: Maybe Bool
- postAccountsAccountPersonsRequestBodyRelationship'Executive :: Maybe Bool
- postAccountsAccountPersonsRequestBodyRelationship'Owner :: Maybe Bool
- postAccountsAccountPersonsRequestBodyRelationship'PercentOwnership :: Maybe PostAccountsAccountPersonsRequestBodyRelationship'PercentOwnership'Variants
- postAccountsAccountPersonsRequestBodyRelationship'Representative :: Maybe Bool
- postAccountsAccountPersonsRequestBodyRelationship'Title :: Maybe Text
- mkPostAccountsAccountPersonsRequestBodyRelationship' :: PostAccountsAccountPersonsRequestBodyRelationship'
- data PostAccountsAccountPersonsRequestBodyRelationship'PercentOwnership'Variants
- data PostAccountsAccountPersonsRequestBodyVerification' = PostAccountsAccountPersonsRequestBodyVerification' {}
- mkPostAccountsAccountPersonsRequestBodyVerification' :: PostAccountsAccountPersonsRequestBodyVerification'
- data PostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument' = PostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument' {}
- mkPostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument' :: PostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument'
- data PostAccountsAccountPersonsRequestBodyVerification'Document' = PostAccountsAccountPersonsRequestBodyVerification'Document' {}
- mkPostAccountsAccountPersonsRequestBodyVerification'Document' :: PostAccountsAccountPersonsRequestBodyVerification'Document'
- data PostAccountsAccountPersonsResponse
Documentation
postAccountsAccountPersons Source #
:: forall m. MonadHTTP m | |
=> Text | account | Constraints: Maximum length of 5000 |
-> Maybe PostAccountsAccountPersonsRequestBody | The request body to send |
-> ClientT m (Response PostAccountsAccountPersonsResponse) | Monadic computation which returns the result of the operation |
POST /v1/accounts/{account}/persons
<p>Creates a new person.</p>
data PostAccountsAccountPersonsRequestBody Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostAccountsAccountPersonsRequestBody | |
|
mkPostAccountsAccountPersonsRequestBody :: PostAccountsAccountPersonsRequestBody Source #
Create a new PostAccountsAccountPersonsRequestBody
with all required fields.
data PostAccountsAccountPersonsRequestBodyAddress' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address
in the specification.
The person's address.
PostAccountsAccountPersonsRequestBodyAddress' | |
|
mkPostAccountsAccountPersonsRequestBodyAddress' :: PostAccountsAccountPersonsRequestBodyAddress' Source #
Create a new PostAccountsAccountPersonsRequestBodyAddress'
with all required fields.
data PostAccountsAccountPersonsRequestBodyAddressKana' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address_kana
in the specification.
The Kana variation of the person's address (Japan only).
PostAccountsAccountPersonsRequestBodyAddressKana' | |
|
Instances
mkPostAccountsAccountPersonsRequestBodyAddressKana' :: PostAccountsAccountPersonsRequestBodyAddressKana' Source #
Create a new PostAccountsAccountPersonsRequestBodyAddressKana'
with all required fields.
data PostAccountsAccountPersonsRequestBodyAddressKanji' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address_kanji
in the specification.
The Kanji variation of the person's address (Japan only).
PostAccountsAccountPersonsRequestBodyAddressKanji' | |
|
Instances
mkPostAccountsAccountPersonsRequestBodyAddressKanji' :: PostAccountsAccountPersonsRequestBodyAddressKanji' Source #
Create a new PostAccountsAccountPersonsRequestBodyAddressKanji'
with all required fields.
data PostAccountsAccountPersonsRequestBodyDob'OneOf1 Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.dob.anyOf
in the specification.
mkPostAccountsAccountPersonsRequestBodyDob'OneOf1 Source #
Create a new PostAccountsAccountPersonsRequestBodyDob'OneOf1
with all required fields.
data PostAccountsAccountPersonsRequestBodyDob'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.dob.anyOf
in the specification.
The person's date of birth.
Instances
data PostAccountsAccountPersonsRequestBodyDocuments' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents
in the specification.
Documents that may be submitted to satisfy various informational requests.
mkPostAccountsAccountPersonsRequestBodyDocuments' :: PostAccountsAccountPersonsRequestBodyDocuments' Source #
Create a new PostAccountsAccountPersonsRequestBodyDocuments'
with all required fields.
data PostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.company_authorization
in the specification.
Instances
mkPostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization' :: PostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization' Source #
Create a new PostAccountsAccountPersonsRequestBodyDocuments'CompanyAuthorization'
with all required fields.
data PostAccountsAccountPersonsRequestBodyDocuments'Passport' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.passport
in the specification.
Instances
mkPostAccountsAccountPersonsRequestBodyDocuments'Passport' :: PostAccountsAccountPersonsRequestBodyDocuments'Passport' Source #
Create a new PostAccountsAccountPersonsRequestBodyDocuments'Passport'
with all required fields.
data PostAccountsAccountPersonsRequestBodyDocuments'Visa' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.visa
in the specification.
Instances
mkPostAccountsAccountPersonsRequestBodyDocuments'Visa' :: PostAccountsAccountPersonsRequestBodyDocuments'Visa' Source #
Create a new PostAccountsAccountPersonsRequestBodyDocuments'Visa'
with all required fields.
data PostAccountsAccountPersonsRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf
in the specification.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
PostAccountsAccountPersonsRequestBodyMetadata'EmptyString | Represents the JSON value |
PostAccountsAccountPersonsRequestBodyMetadata'Object Object |
Instances
data PostAccountsAccountPersonsRequestBodyRelationship' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.relationship
in the specification.
The relationship that this person has with the account's legal entity.
Instances
mkPostAccountsAccountPersonsRequestBodyRelationship' :: PostAccountsAccountPersonsRequestBodyRelationship' Source #
Create a new PostAccountsAccountPersonsRequestBodyRelationship'
with all required fields.
data PostAccountsAccountPersonsRequestBodyRelationship'PercentOwnership'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.relationship.properties.percent_ownership.anyOf
in the specification.
PostAccountsAccountPersonsRequestBodyRelationship'PercentOwnership'EmptyString | Represents the JSON value |
PostAccountsAccountPersonsRequestBodyRelationship'PercentOwnership'Double Double |
Instances
data PostAccountsAccountPersonsRequestBodyVerification' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification
in the specification.
The person's verification status.
Instances
mkPostAccountsAccountPersonsRequestBodyVerification' :: PostAccountsAccountPersonsRequestBodyVerification' Source #
Create a new PostAccountsAccountPersonsRequestBodyVerification'
with all required fields.
data PostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification.properties.additional_document
in the specification.
PostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument' | |
|
Instances
mkPostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument' :: PostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument' Source #
Create a new PostAccountsAccountPersonsRequestBodyVerification'AdditionalDocument'
with all required fields.
data PostAccountsAccountPersonsRequestBodyVerification'Document' Source #
Defines the object schema located at paths./v1/accounts/{account}/persons.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification.properties.document
in the specification.
PostAccountsAccountPersonsRequestBodyVerification'Document' | |
|
Instances
mkPostAccountsAccountPersonsRequestBodyVerification'Document' :: PostAccountsAccountPersonsRequestBodyVerification'Document' Source #
Create a new PostAccountsAccountPersonsRequestBodyVerification'Document'
with all required fields.
data PostAccountsAccountPersonsResponse Source #
Represents a response of the operation postAccountsAccountPersons
.
The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostAccountsAccountPersonsResponseError
is used.
PostAccountsAccountPersonsResponseError String | Means either no matching case available or a parse error |
PostAccountsAccountPersonsResponse200 Person | Successful response. |
PostAccountsAccountPersonsResponseDefault Error | Error response. |