{ "swagger": "2.0", "info": { "title": "elided.", "description": "elided.", "version": "0.17.10", "contact": { "name": "Apiture", "url": "https://developer.apiture.com", "email": "api@apiture.com" }, "termsOfService": "https://developer.apiture.com/docs/Apiture-Open-API-License-Agreement.pdf" }, "schemes": [ "https" ], "basePath": "/accountApplications", "consumes": [ "application/hal+json", "application/json" ], "produces": [ "application/hal+json", "application/json" ], "tags": [ { "name": "Account Application", "description": "elided." }, { "name": "Account Application Actions", "description": "elided." }, { "name": "Enrollment", "description": "elided." }, { "name": "Enrollment Actions", "description": "elided." }, { "name": "API", "description": "elided." }, { "name": "Configuration", "description": "elided." } ], "paths": { "/expiredApplications": { "post": { "operationId": "expireApplication", "security": [ { "apiKey": [], "accessToken": [ "data/write" ] } ], "summary": "elided.", "description": "elided.", "tags": [ "Account Application Actions" ], "parameters": [ { "$ref": "#/parameters/applicationQueryParam" }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400ExpireApplication" }, "409": { "$ref": "#/responses/409ExpireApplicationConflict" } } } }, "/rejectedApplications": { "post": { "operationId": "rejectApplication", "security": [ { "apiKey": [], "accessToken": [ "data/write" ] } ], "summary": "elided.", "description": "elided.", "tags": [ "Account Application Actions" ], "parameters": [ { "$ref": "#/parameters/applicationQueryParam" }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400RejectApplication" }, "409": { "$ref": "#/responses/409RejectApplicationConflict" } } } }, "/approvedApplications": { "post": { "operationId": "approveApplication", "security": [ { "apiKey": [], "accessToken": [ "banking/write", "profiles/write", "data/write" ] } ], "summary": "elided.", "description": "elided.", "tags": [ "Account Application Actions" ], "parameters": [ { "$ref": "#/parameters/applicationQueryParam" }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400ApproveApplication" }, "409": { "$ref": "#/responses/409ApproveApplicationConflict" } } } }, "/canceledApplications": { "post": { "operationId": "cancelApplication", "security": [ { "apiKey": [], "accessToken": [ "data/write" ] } ], "summary": "elided.", "description": "elided.", "tags": [ "Account Application Actions" ], "parameters": [ { "$ref": "#/parameters/applicationQueryParam" }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400CancelApplication" }, "409": { "$ref": "#/responses/409CancelApplicationConflict" } } } }, "/runningApplications": { "post": { "operationId": "startApplication", "security": [ { "apiKey": [], "accessToken": [ "banking/write", "profiles/write", "data/write" ] } ], "summary": "elided.", "description": "elided.", "parameters": [ { "$ref": "#/parameters/applicationQueryParam" }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "tags": [ "Account Application Actions" ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400StartApplication" }, "409": { "$ref": "#/responses/409StartApplicationConflict" } } }, "get": { "summary": "elided.", "description": "elided.", "operationId": "getRunningApplications", "security": [ { "apiKey": [], "accessToken": [ "data/read" ] } ], "tags": [ "Account Application" ], "parameters": [ { "name": "start", "in": "query", "description": "elided.", "type": "integer", "format": "int64", "default": 0 }, { "name": "limit", "in": "query", "description": "elided.", "type": "integer", "format": "int32", "default": 100 }, { "name": "sortBy", "in": "query", "type": "string", "description": "elided." }, { "$ref": "#/parameters/filterQueryParam" }, { "$ref": "#/parameters/qQueryParam" }, { "$ref": "#/parameters/stateQueryParam" }, { "$ref": "#/parameters/nameQueryParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/applications" } }, "400": { "$ref": "#/responses/400" }, "422": { "$ref": "#/responses/422" } } } }, "/blockedApplications": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getBlockedApplications", "security": [ { "apiKey": [], "accessToken": [ "data/read" ] } ], "tags": [ "Account Application" ], "parameters": [ { "name": "start", "in": "query", "description": "elided.", "type": "integer", "format": "int64", "default": 0 }, { "name": "limit", "in": "query", "description": "elided.", "type": "integer", "format": "int32", "default": 100 }, { "name": "sortBy", "in": "query", "type": "string", "description": "elided." }, { "$ref": "#/parameters/filterQueryParam" }, { "$ref": "#/parameters/qQueryParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/applications" } }, "400": { "$ref": "#/responses/400" }, "422": { "$ref": "#/responses/422" } } } }, "/applications": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getApplications", "security": [ { "apiKey": [], "accessToken": [ "data/read" ] } ], "tags": [ "Account Application" ], "parameters": [ { "name": "start", "in": "query", "description": "elided.", "type": "integer", "format": "int64", "default": 0 }, { "name": "limit", "in": "query", "description": "elided.", "type": "integer", "format": "int32", "default": 100 }, { "name": "sortBy", "in": "query", "type": "string", "description": "elided." }, { "name": "applicant", "in": "query", "type": "string", "description": "elided." }, { "$ref": "#/parameters/filterQueryParam" }, { "$ref": "#/parameters/qQueryParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/applications" } }, "400": { "$ref": "#/responses/400" }, "422": { "$ref": "#/responses/422" } } }, "post": { "summary": "elided.", "description": "elided.", "operationId": "createApplication", "security": [ { "apiKey": [], "accessToken": [ "banking/write", "profiles/write", "data/write" ] } ], "tags": [ "Account Application" ], "parameters": [ { "name": "application", "in": "body", "description": "elided.", "required": true, "schema": { "$ref": "#/definitions/createApplication" } } ], "responses": { "201": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "Location": { "description": "elided.", "type": "string", "format": "uri" }, "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400" } } } }, "/applications/{applicationId}": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getApplication", "security": [ { "apiKey": [], "accessToken": [ "banking/read", "profiles/read", "data/read" ] } ], "tags": [ "Account Application" ], "parameters": [ { "$ref": "#/parameters/applicationIdPathParam" }, { "$ref": "#/parameters/ifNoneMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "304": { "$ref": "#/responses/304" }, "404": { "$ref": "#/responses/404Application" } } }, "put": { "summary": "elided.", "description": "elided.", "operationId": "updateApplication", "security": [ { "apiKey": [], "accessToken": [ "banking/write", "profiles/write", "data/write" ] } ], "tags": [ "Account Application" ], "parameters": [ { "$ref": "#/parameters/applicationIdPathParam" }, { "name": "application", "in": "body", "required": true, "schema": { "$ref": "#/definitions/application" } }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400" }, "404": { "$ref": "#/responses/404Application" }, "412": { "$ref": "#/responses/412" }, "422": { "$ref": "#/responses/422" } } }, "patch": { "summary": "elided.", "description": "elided.", "operationId": "patchApplication", "security": [ { "apiKey": [], "accessToken": [ "banking/write", "profiles/write", "data/write" ] } ], "tags": [ "Account Application" ], "parameters": [ { "$ref": "#/parameters/applicationIdPathParam" }, { "name": "application", "in": "body", "required": true, "schema": { "$ref": "#/definitions/application" } }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/application" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400" }, "404": { "$ref": "#/responses/404Application" }, "412": { "$ref": "#/responses/412" }, "422": { "$ref": "#/responses/422" } } }, "delete": { "summary": "elided.", "description": "elided.", "operationId": "deleteApplication", "security": [ { "apiKey": [], "accessToken": [ "banking/delete", "profiles/delete", "data/delete" ] } ], "tags": [ "Account Application" ], "parameters": [ { "$ref": "#/parameters/ifMatchHeaderParam" }, { "$ref": "#/parameters/applicationIdPathParam" } ], "responses": { "204": { "$ref": "#/responses/204Deleted" }, "409": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "412": { "$ref": "#/responses/412" } } } }, "/configurations": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getConfiguration", "security": [ { "apiKey": [], "accessToken": [ "admin/read" ] } ], "tags": [ "Configuration" ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/configuration" } } }, "parameters": [] } }, "/configurations/groups": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getConfigurationGroups", "security": [ { "apiKey": [], "accessToken": [ "admin/read" ] } ], "tags": [ "Configuration" ], "parameters": [ { "name": "start", "in": "query", "description": "elided.", "type": "integer", "format": "int64", "default": 0 }, { "name": "limit", "in": "query", "description": "elided.", "type": "integer", "format": "int32", "default": 100 }, { "name": "sortBy", "in": "query", "type": "string", "description": "elided." }, { "$ref": "#/parameters/filterQueryParam" }, { "$ref": "#/parameters/qQueryParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/configurationGroups" } }, "400": { "$ref": "#/responses/400" }, "422": { "$ref": "#/responses/422" } } } }, "/configurations/groups/{groupName}": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getConfigurationGroup", "security": [ { "apiKey": [], "accessToken": [ "admin/read" ] } ], "tags": [ "Configuration" ], "parameters": [ { "$ref": "#/parameters/configurationGroupNamePathParam" }, { "$ref": "#/parameters/ifNoneMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/configurationGroup" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "304": { "$ref": "#/responses/304" }, "404": { "$ref": "#/responses/404ConfigurationGroup" }, "412": { "$ref": "#/responses/412" } } } }, "/configurations/groups/{groupName}/schema": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getConfigurationGroupSchema", "security": [ { "apiKey": [], "accessToken": [ "admin/read" ] } ], "tags": [ "Configuration" ], "parameters": [ { "$ref": "#/parameters/configurationGroupNamePathParam" }, { "$ref": "#/parameters/ifNoneMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/configurationSchema" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "304": { "$ref": "#/responses/304" }, "404": { "$ref": "#/responses/404ConfigurationGroup" } } } }, "/configurations/groups/{groupName}/values": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getConfigurationGroupValues", "security": [ { "apiKey": [], "accessToken": [ "admin/read" ] } ], "tags": [ "Configuration" ], "parameters": [ { "$ref": "#/parameters/configurationGroupNamePathParam" }, { "$ref": "#/parameters/ifNoneMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/configurationValues" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "304": { "$ref": "#/responses/304" }, "404": { "$ref": "#/responses/404ConfigurationGroup" } } }, "put": { "summary": "elided.", "description": "elided.", "operationId": "updateConfigurationGroupValues", "security": [ { "apiKey": [], "accessToken": [ "admin/write" ] } ], "tags": [ "Configuration" ], "parameters": [ { "$ref": "#/parameters/configurationGroupNamePathParam" }, { "name": "configuration group values", "in": "body", "required": true, "schema": { "$ref": "#/definitions/configurationValues" } }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/configurationSchema" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400" }, "404": { "$ref": "#/responses/404ConfigurationGroup" }, "412": { "$ref": "#/responses/412" } } } }, "/configurations/groups/{groupName}/values/{valueName}": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getConfigurationGroupValue", "security": [ { "apiKey": [], "accessToken": [ "admin/read" ] } ], "tags": [ "Configuration" ], "parameters": [ { "$ref": "#/parameters/configurationGroupNamePathParam" }, { "$ref": "#/parameters/configurationGroupValueNamePathParam" } ], "responses": { "200": { "description": "elided.", "schema": { "type": "string" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "404": { "$ref": "#/responses/404ConfigurationGroupOrValue" } } }, "put": { "summary": "elided.", "description": "elided.", "operationId": "updateConfigurationGroupValue", "security": [ { "apiKey": [], "accessToken": [ "admin/write" ] } ], "tags": [ "Configuration" ], "parameters": [ { "$ref": "#/parameters/configurationGroupNamePathParam" }, { "$ref": "#/parameters/configurationGroupValueNamePathParam" }, { "name": "value", "description": "elided.", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "elided.", "schema": { "type": "string" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "403": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } } } } }, "/enrollments": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getEnrollments", "tags": [ "Enrollment" ], "parameters": [ { "name": "start", "in": "query", "description": "elided.", "type": "integer", "format": "int64", "default": 0 }, { "name": "limit", "in": "query", "description": "elided.", "type": "integer", "format": "int32", "default": 100 }, { "name": "sortBy", "in": "query", "type": "string", "description": "elided." }, { "$ref": "#/parameters/filterQueryParam" }, { "$ref": "#/parameters/qQueryParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/enrollments" } }, "400": { "$ref": "#/responses/400" }, "422": { "$ref": "#/responses/422" } }, "security": [ { "apiKey": [], "accessToken": [ "admin/read" ] } ] }, "post": { "summary": "elided.", "description": "elided.", "operationId": "createEnrollment", "tags": [ "Enrollment" ], "parameters": [ { "name": "enrollment", "in": "body", "description": "elided.", "required": true, "schema": { "$ref": "#/definitions/createEnrollment" } } ], "responses": { "201": { "description": "elided.", "schema": { "$ref": "#/definitions/enrollment" }, "headers": { "Location": { "description": "elided.", "type": "string", "format": "uri" }, "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400" } }, "security": [ { "apiKey": [], "accessToken": [ "data/read", "profile/read" ] } ] } }, "/enrollments/{enrollmentId}": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getEnrollment", "tags": [ "Enrollment" ], "parameters": [ { "$ref": "#/parameters/enrollmentIdPathParam" }, { "$ref": "#/parameters/ifNoneMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/enrollment" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "304": { "$ref": "#/responses/304" }, "404": { "$ref": "#/responses/404Enrollment" } }, "security": [ { "apiKey": [], "accessToken": [ "profiles/read", "data/read" ] } ] }, "put": { "summary": "elided.", "description": "elided.", "operationId": "updateEnrollment", "tags": [ "Enrollment" ], "parameters": [ { "$ref": "#/parameters/enrollmentIdPathParam" }, { "name": "enrollment", "in": "body", "required": true, "schema": { "$ref": "#/definitions/enrollment" } }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/enrollment" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400" }, "404": { "$ref": "#/responses/404Enrollment" }, "412": { "$ref": "#/responses/412" }, "422": { "$ref": "#/responses/422" } }, "security": [ { "apiKey": [], "accessToken": [ "profiles/write", "data/write" ] } ] }, "patch": { "summary": "elided.", "description": "elided.", "operationId": "patchEnrollment", "tags": [ "Enrollment" ], "parameters": [ { "$ref": "#/parameters/enrollmentIdPathParam" }, { "name": "enrollment", "in": "body", "required": true, "schema": { "$ref": "#/definitions/enrollment" } }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/enrollment" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400" }, "404": { "$ref": "#/responses/404Enrollment" }, "412": { "$ref": "#/responses/412" }, "422": { "$ref": "#/responses/422" } }, "security": [ { "apiKey": [], "accessToken": [ "profiles/write", "data/write" ] } ] }, "delete": { "summary": "elided.", "description": "elided.", "operationId": "deleteEnrollment", "tags": [ "Enrollment" ], "parameters": [ { "$ref": "#/parameters/enrollmentIdPathParam" } ], "responses": { "204": { "$ref": "#/responses/204Deleted" } }, "security": [ { "apiKey": [], "accessToken": [ "profiles/delete", "data/delete" ] } ] } }, "/rejectedEnrollments": { "post": { "operationId": "rejectEnrollment", "summary": "elided.", "description": "elided.", "tags": [ "Enrollment Actions" ], "security": [ { "apiKey": [], "accessToken": [ "profiles/write", "data/write", "admin/write" ] } ], "parameters": [ { "$ref": "#/parameters/enrollmentQueryParam" }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/enrollment" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400RejectEnrollment" }, "409": { "$ref": "#/responses/409RejectEnrollmentConflict" }, "412": { "$ref": "#/responses/412" } } } }, "/approvedEnrollments": { "post": { "operationId": "approveEnrollment", "summary": "elided.", "description": "elided.", "tags": [ "Enrollment Actions" ], "security": [ { "apiKey": [], "accessToken": [ "banking/write", "profiles/write", "data/write", "admin/write" ] } ], "parameters": [ { "$ref": "#/parameters/enrollmentQueryParam" }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/enrollment" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400ApproveEnrollment" }, "409": { "$ref": "#/responses/409ApproveEnrollmentConflict" }, "412": { "$ref": "#/responses/412" } } } }, "/canceledEnrollments": { "post": { "operationId": "cancelEnrollment", "summary": "elided.", "description": "elided.", "tags": [ "Enrollment Actions" ], "security": [ { "apiKey": [], "accessToken": [ "profiles/write", "data/write" ] } ], "parameters": [ { "$ref": "#/parameters/enrollmentQueryParam" }, { "$ref": "#/parameters/ifMatchHeaderParam" } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/enrollment" }, "headers": { "ETag": { "description": "elided.", "type": "string" } } }, "400": { "$ref": "#/responses/400CancelEnrollment" }, "409": { "$ref": "#/responses/409CancelEnrollmentConflict" }, "412": { "$ref": "#/responses/412" } } } }, "/": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getApi", "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "elided.", "schema": { "$ref": "#/definitions/root" } } }, "tags": [ "API" ], "parameters": [] } }, "/apiDoc": { "get": { "summary": "elided.", "description": "elided.", "operationId": "getApiDoc", "security": [ { "apiKey": [] } ], "produces": [ "application/json", "application/openapi+json;version=2.0", "application/openapi+yaml;version=2.0" ], "responses": { "200": { "description": "elided.", "schema": { "type": "object" } } }, "tags": [ "API" ], "parameters": [] } } }, "parameters": { "applicationQueryParam": { "name": "application", "required": true, "in": "query", "type": "string", "description": "elided." }, "applicationIdPathParam": { "name": "applicationId", "description": "elided.", "in": "path", "type": "string", "required": true }, "enrollmentIdPathParam": { "name": "enrollmentId", "description": "elided.", "in": "path", "type": "string", "required": true }, "enrollmentQueryParam": { "name": "enrollment", "required": true, "in": "query", "type": "string", "description": "elided." }, "filterQueryParam": { "name": "filter", "in": "query", "description": "elided.", "type": "string" }, "qQueryParam": { "name": "q", "in": "query", "description": "elided.", "type": "string" }, "stateQueryParam": { "name": "state", "in": "query", "description": "elided.", "type": "string", "enum": [ "pending", "running", "blocked", "canceled", "expired", "rejected", "approved" ] }, "nameQueryParam": { "name": "name", "in": "query", "description": "elided.", "type": "string" }, "ifMatchHeaderParam": { "name": "If-Match", "description": "elided.", "in": "header", "type": "string", "required": true }, "ifNoneMatchHeaderParam": { "name": "If-None-Match", "description": "elided.", "in": "header", "type": "string" }, "configurationGroupNamePathParam": { "name": "groupName", "description": "elided.", "in": "path", "type": "string", "required": true }, "configurationGroupValueNamePathParam": { "name": "valueName", "description": "elided.", "in": "path", "type": "string", "required": true } }, "securityDefinitions": { "apiKey": { "type": "apiKey", "name": "API-Key", "in": "header", "description": "elided." }, "accessToken": { "type": "oauth2", "flow": "accessCode", "description": "elided.", "authorizationUrl": "/auth/oauth2/authorize", "tokenUrl": "/auth/oauth2/token", "scopes": { "banking/read": "Read access to accounts and account-related resources such as transfers and transactions.", "banking/write": "Write (update) access to accounts and account-related resources such as transfers and transactions.", "banking/delete": "Delete access to editable accounts and account-related resources such as transfers.", "banking/readBalance": "Read access to account balances. This must be granted in addition to the `banking/read` scope in order to view balances, but is included in the `banking/full` scope.", "banking/full": "Full access to accounts and account-related resources such as transfers and transactions.", "profiles/read": "Read access to user and contact related resources.", "profiles/write": "Write (update) access to user and contact related resources.", "profiles/delete": "Delete access to user and contact related resources.", "profiles/readPii": "Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.", "profiles/full": "Full access to user and contact related resources.", "data/read": "Read access to non-account, non-profile data.", "data/write": "Write (update) access to non-account, non-profile data.", "data/delete": "Delete access to non-account, non-profile data.", "data/full": "Full access to non-account, non-profile data.", "admin/read": "Read access to system configuration.", "admin/write": "Write (update) access to system configuration.", "admin/delete": "Delete access to system configuration.", "admin/full": "Full access to system configuration." } } }, "responses": { "304": { "description": "elided." }, "400": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "412": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "422": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "400ExpireApplication": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "409ExpireApplicationConflict": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "400RejectApplication": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "409RejectApplicationConflict": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "400ApproveApplication": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "409ApproveApplicationConflict": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "400CancelEnrollment": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "409CancelEnrollmentConflict": { "description": "elided." }, "400RejectEnrollment": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "409RejectEnrollmentConflict": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "400ApproveEnrollment": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "409ApproveEnrollmentConflict": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "400CancelApplication": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "409CancelApplicationConflict": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "400StartApplication": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "409StartApplicationConflict": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "404Application": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "404Enrollment": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "204Deleted": { "description": "elided." }, "404ConfigurationGroup": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "404ConfigurationGroupOrValue": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } }, "400unverifiedApplications": { "description": "elided.", "schema": { "$ref": "#/definitions/errorResponse" } } }, "definitions": { "commonFields": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "applicantName": { "title": "elided.", "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1, "readOnly": true, "example": "Elsa Snowqueen" }, "workflowState": { "description": "elided.", "type": "string", "readOnly": true, "maxLength": 16, "minLength": 1, "example": "running" }, "state": { "description": "elided.", "type": "string", "enum": [ "pending", "running", "blocked", "canceled", "expired", "rejected", "approved" ], "readOnly": true, "example": "running" }, "flaggedForReview": { "description": "elided.", "type": "boolean", "readOnly": true, "example": false }, "createdAt": { "description": "elided.", "type": "string", "readOnly": true, "format": "date-time" }, "completedAt": { "description": "elided.", "type": "string", "format": "date-time", "readOnly": true } } }, "applicationFields": { "title": "elided.", "description": "elided.", "properties": { "accountName": { "description": "elided.", "type": "string", "maxLength": 128 }, "fundingAmount": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/money" } ] }, "attributes": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/attributes" } ] } } }, "applicationObjects": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "products": { "description": "elided.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/summaryProduct" } }, "organization": { "description": "elided.", "type": "object", "$ref": "#/definitions/organization" }, "organizationVerification": { "description": "elided.", "type": "object", "$ref": "#/definitions/businessVerifications" }, "organizationApprovals": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/approval" } }, "accountApproval": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/approval" } ] }, "fundingAccount": { "description": "elided.", "type": "object", "$ref": "#/definitions/verifiedTransferAccount" }, "newAccounts": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/transferAccount" } } } }, "createApplication": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractRequest" }, { "$ref": "#/definitions/applicationFields" }, { "$ref": "#/definitions/commonObjects" }, { "$ref": "#/definitions/applicationObjects" } ], "required": [ "products" ], "example": { "_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json", "accountName": "My checking account", "_links": { "apiture:product": { "href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18" } }, "applicants": [ { "username": "Snowqueen123", "contact": { "firstName": "Elsa", "lastName": "Snowqueen", "_links": { "self": { "href": "https://www.example.com/users/user/3017d005-9910-4a8b-874b-397749353e7a" } } }, "role": { "name": "primaryUser", "label": "Primary User", "_links": { "self": { "href": "https://www.example.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228" } } } } ], "products": [ { "name": "Personal Savings", "_links": { "self": { "href": "https://www.example.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f" } } } ] } }, "summaryApplication": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "$ref": "#/definitions/commonFields" }, { "$ref": "#/definitions/applicationFields" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "productName": { "description": "elided.", "type": "string", "readOnly": true, "maxLength": 128, "minLength": 1, "example": "Personal Savings" }, "organizationName": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1, "readOnly": true, "example": "Smith's Auto Detailing" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json", "applicantName": "Elsa Snowqueen", "accountName": "My Premiere Savings", "productName": "Premiere Savings", "fundingAmount": { "value": "1500.00", "currency": "USD" }, "state": "running", "workflowState": "running", "createdAt": "2018-12-13T11:01:41.375Z", "_links": { "self": { "href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c" }, "apiture:product": { "href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18" } } } }, "application": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/summaryApplication" }, { "$ref": "#/definitions/commonObjects" }, { "$ref": "#/definitions/applicationObjects" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "completedTaskCount": { "description": "elided.", "type": "integer", "format": "int32", "minimum": 0, "example": 4, "readOnly": true }, "runningTaskCount": { "description": "elided.", "type": "integer", "format": "int32", "minimum": 0, "example": 2, "readOnly": true }, "runningTaskNames": { "description": "elided.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "pendingTaskCount": { "description": "elided.", "type": "integer", "format": "int32", "minimum": 0, "example": 3, "readOnly": true }, "blockedTaskCount": { "description": "elided.", "type": "integer", "format": "int32", "minimum": 0, "example": 0, "readOnly": true }, "canceledTaskCount": { "description": "elided.", "type": "integer", "format": "int32", "minimum": 0, "example": 0, "readOnly": true }, "expiresAt": { "description": "elided.", "type": "string", "format": "date-time", "readOnly": true, "example": "2019-08-28T10:19:24.000Z" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/accountApplications/application/v1.0.0/profile.json", "applicantName": "Elsa Snowqueen", "accountName": "My Premiere Savings", "productName": "Premiere Savings", "fundingAmount": { "value": "1500.00", "currency": "USD" }, "state": "running", "workflowState": "running", "createdAt": "2018-12-13T11:01:41.375Z", "fundingAccount": { "title": "elided.", "institutionName": "3rd Party Bank", "routingNumber": "021000021", "accountNumbers": { "full": "9876543210", "masked": "*************3210" } }, "organization": {}, "applicants": [], "products": [], "documents": [], "accountApproval": { "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6", "label": "Account Approval: Premiere Savings, Elsa Snowqueen", "state": "open", "done": false, "typeName": "accountApplication", "type": { "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b", "name": "accountApplication", "label": "Account Application", "domain": "https://api.apiture.com/approvals", "_links": { "self": { "href": "https://www.example.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c" } } }, "createdAt": "2019-12-14T06:41:35.375Z", "_links": { "self": { "href": "https://www.example.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4" } } }, "consents": [], "_links": { "self": { "href": "https://www.example.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c" }, "apiture:product": { "href": "https://www.example.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18" }, "apiture:workflow": { "href": "https://www.example.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121" }, "apiture:fundingAccount": { "href": "https://www.example.comaccounts/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2" }, "apiture:applicant": { "href": "https://www.example.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569" }, "apiture:organization": { "href": "https://www.example.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2" }, "apiture:approval": { "href": "https://www.example.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a" } } } }, "enrollmentFields": { "title": "elided.", "description": "elided.", "properties": { "applicant": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/applicant" } ] } } }, "commonObjects": { "title": "elided.", "description": "elided.", "properties": { "applicants": { "description": "elided.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/applicant" } }, "requiredDocuments": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/requiredDocument" } }, "documents": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/document" } }, "approvals": { "description": "elided.", "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/approval" } } } }, "createEnrollment": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractRequest" }, { "$ref": "#/definitions/enrollmentFields" }, { "$ref": "#/definitions/commonObjects" } ] }, "summaryEnrollment": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/commonFields" }, { "$ref": "#/definitions/enrollmentFields" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" } } }, { "$ref": "#/definitions/abstractResource" } ] }, "enrollment": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/commonObjects" }, { "$ref": "#/definitions/summaryEnrollment" } ] }, "enrollments": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/collection" }, { "type": "object", "properties": { "_embedded": { "type": "object", "description": "elided.", "properties": { "items": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/summaryEnrollment" } } } } } } ], "example": { "_profile": "https://api.apiture.com/schemas/accountApplications/enrollments/v2.0.0/profile.json", "start": 10, "limit": 10, "count": 67, "_links": { "self": { "href": "https://www.example.com/accountApplications/enrollments?start=10&limit=10" }, "first": { "href": "https://www.example.com/accountApplications/enrollments?start=0&limit=10" }, "next": { "href": "https://www.example.com/accountApplications/enrollments?start=20&limit=10" }, "collection": { "href": "https://www.example.com/accountApplications/enrollments" } }, "_embedded": { "items": [ { "_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json", "_links": { "self": { "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365c" } }, "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "name": "My Personal Checking", "state": "running" }, { "_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json", "_links": { "self": { "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365d" } }, "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "state": "approved" } ] } } }, "applications": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/collection" }, { "type": "object", "properties": { "_embedded": { "type": "object", "description": "elided.", "properties": { "items": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/summaryApplication" } } } } } } ], "example": { "_profile": "https://api.apiture.com/schemas/accountApplications/applications/v2.0.0/profile.json", "start": 10, "limit": 10, "count": 67, "name": "account applications", "_links": { "self": { "href": "https://www.example.com/accountApplications/applications?start=10&limit=10" }, "first": { "href": "https://www.example.com/accountApplications/applications?start=0&limit=10" }, "next": { "href": "https://www.example.com/accountApplications/applications?start=20&limit=10" }, "collection": { "href": "https://www.example.com/accountApplications/applications" } }, "_embedded": { "items": [ { "_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json", "_links": { "self": { "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c" } }, "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "name": "My Personal Checking", "state": "running" }, { "_profile": "https://api.apiture.com/schemas/accountApplication/v1.0.0/profile.json", "_links": { "self": { "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d" } }, "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "name": "6 Month CD", "state": "approved" } ] } } }, "applicant": { "title": "elided.", "description": "elided.", "properties": { "username": { "description": "elided.", "type": "string" }, "contact": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/contact" } ] }, "user": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/summaryUser" } ] }, "role": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/role" } ] }, "verification": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/contactVerification" } ] }, "approvals": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/approval" } }, "consents": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/consent" } }, "fraudReport": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/fraudRiskReport" } ] }, "verified": { "description": "elided.", "type": "boolean", "readOnly": true }, "verificationToken": { "description": "elided.", "type": "string", "readOnly": true } } }, "requiredDocument": { "title": "elided.", "description": "elided.", "type": "object", "required": [ "label", "type", "productTarget", "category", "requireIfVerified" ], "properties": { "label": { "description": "elided.", "type": "string" }, "type": { "description": "elided.", "type": "string", "example": "governmentId" }, "productTarget": { "description": "elided.", "type": "string", "enum": [ "business", "personal" ] }, "documentUri": { "description": "elided.", "type": "string" }, "category": { "description": "elided.", "type": "string", "enum": [ "driversLicense", "militaryIdentification", "passport", "socialSecurityCard", "stateIdentification", "taxForm", "utilityBill", "articlesOfOrganization" ], "example": "driversLicense" }, "requireIfVerified": { "description": "elided.", "type": "boolean" } } }, "document": { "title": "elided.", "description": "elided.", "required": [ "uri", "contentType", "revisedAt" ], "properties": { "uri": { "description": "elided.", "type": "string", "format": "uri", "maxLength": 2048 }, "contentType": { "description": "elided.", "example": "application/pdf" }, "revisionId": { "description": "elided.", "type": "string", "example": "2019:1.2.0" }, "revisedAt": { "description": "elided.", "type": "string", "format": "date-time" } } }, "verifiedTransferAccount": { "title": "elided.", "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/transferAccount" } ], "properties": { "verificationReport": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/verificationReport" } ] }, "state": { "description": "elided.", "type": "string", "readOnly": true, "allOf": [ { "$ref": "#/definitions/externalAccountState" } ] } } }, "errorResponse": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" } ], "example": { "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json", "_error": { "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3", "message": "The value for deposit must be greater than 0.", "statusCode": 422, "type": "positiveNumberRequired", "attributes": { "value": -125.5 }, "remediation": "Provide a value which is greater than 0", "occurredAt": "2018-01-25T05:50:52.375Z", "_links": { "describedby": { "href": "https://api.apiture.com/errors/positiveNumberRequired" } }, "_embedded": { "errors": [] } } } }, "configuration": { "title": "elided.", "description": "elided.", "properties": { "_links": { "$ref": "#/definitions/links" } }, "example": { "_links": { "self": { "href": "/configurations/configurations/" }, "apiture:groups": { "href": "/configurations/configurations/groups" } } } }, "configurationGroups": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/collection" }, { "type": "object", "properties": { "_embedded": { "description": "elided.", "type": "object", "properties": { "items": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/configurationGroupSummary" } } } } } } ], "example": { "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.0.0/profile.json", "start": 10, "limit": 10, "count": 67, "name": "configurationGroups", "_links": { "self": { "href": "/configurations/configurations/groups?start=10&limit=10" }, "first": { "href": "/configurations/configurations/groups?start=0&limit=10" }, "next": { "href": "/configurations/configurations/groups?start=20&limit=10" }, "collection": { "href": "/configurations/configurations/groups" } }, "_embedded": { "items": [ { "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json", "_links": { "self": { "href": "/configurations/groups/basic" } }, "name": "basic", "label": "Basic Settings", "description": "elided." }, { "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json", "_links": { "self": { "href": "/configurations/groups/calendar" } }, "name": "calendar", "label": "Calendar", "description": "elided." } ] } } }, "configurationGroup": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/configurationGroupSummary" }, { "type": "object", "properties": { "schema": { "$ref": "#/definitions/configurationSchema" }, "values": { "$ref": "#/definitions/configurationValues" } } } ], "example": { "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.0/profile.json", "_links": { "self": { "href": "/configurations/groups/basic" } }, "name": "basic", "label": "Basic Settings", "description": "elided.", "schema": { "type": "object", "properties": { "dailyLimit": { "type": "number", "description": "elided." }, "cutoffTime": { "type": "string", "format": "time", "description": "elided." } } }, "values": { "dailyLimit": 5, "cutoffTime": "17:30:00" } } }, "configurationSchema": { "title": "elided.", "description": "elided.", "type": "object", "additionalProperties": { "$ref": "#/definitions/configurationSchemaValue" }, "example": { "type": "object", "properties": { "dailyLimit": { "type": "number", "description": "elided." }, "cutoffTime": { "type": "string", "format": "time", "description": "elided." } } } }, "configurationValues": { "title": "elided.", "description": "elided.", "type": "object", "additionalProperties": { "$ref": "#/definitions/configurationValue" }, "example": { "dailyLimit": 5, "cutoffTime": "17:30:00" } }, "root": { "title": "elided.", "description": "elided.", "example": { "id": "apiName", "name": "API name", "apiVersion": "1.0.0", "_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json", "_links": {} }, "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "name": { "type": "string", "description": "elided." }, "apiVersion": { "type": "string", "description": "elided." } } } ] }, "money": { "title": "elided.", "description": "elided.", "properties": { "value": { "description": "elided.", "example": "3456.78", "type": "string" }, "currency": { "description": "elided.", "type": "string", "minLength": 3, "maxLength": 3 } } }, "attributes": { "title": "elided.", "description": "elided.", "type": "object", "additionalProperties": { "$ref": "#/definitions/attributeValue" } }, "summaryProduct": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "$ref": "#/definitions/productFields" }, { "$ref": "#/definitions/revisionEffectiveInterval" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "type": { "description": "elided.", "type": "string", "readOnly": true }, "subtype": { "description": "elided.", "type": "string", "readOnly": true }, "timeDeposit": { "$ref": "#/definitions/timeDeposit" }, "constraints": { "$ref": "#/definitions/constraints" } } } ], "example": { "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd", "_profile": "https://api.apiture.com/schemas/products/product/v1.0.0/profile.json", "_links": { "self": { "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd" }, "apiture:productType": { "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8" }, "apiture:productSubtype": { "href": "/products/productTypes/fa4f2335-3306-4721-b74c-8ec0c77823e9" } }, "name": "Premiere Checking", "label": "Premiere Checking", "description": "elided.", "state": "active", "type": "Demand Deposit", "subtype": "Demand Deposit with Interest", "newAccountAvailability": "available", "revision": "2018-04-25T07:56:46.375Z", "_embedded": {}, "ifxType": "DDA" } }, "organization": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/summaryOrganization" }, { "type": "object", "properties": { "createdAt": { "description": "elided.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "elided.", "type": "string", "format": "date-time" }, "attributes": { "type": "object", "description": "elided." }, "_embedded": { "description": "elided.", "type": "object", "properties": { "authorizedSigners": { "$ref": "#/definitions/authorizedSigners" }, "beneficialOwners": { "$ref": "#/definitions/beneficialOwners" } } } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "customerId": "000489353781", "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json", "name": "Smith's Auto Detailing", "label": "Smith's Detailing", "tradeName": "Smith's Auto Detailing", "emailAddresses": [ { "_id": "ea0", "type": "work", "value": "smitties-detailing@example.com" } ], "preferredEmailAddressId": "ea0", "phones": [ { "type": "work", "number": "(555) 555-5555", "_id": "wp0" }, { "type": "mobile", "number": "(999) 555-5555", "_id": "wp1" } ], "preferredPhoneNumberId": "wp0", "addresses": [ { "type": "work", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "type": "work", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "preferredMailingAddressId": "wa0", "establishedDate": "2009-07-09T", "identification": [ { "type": "taxId", "value": "00-9999999" } ], "state": "active", "governmentOwned": false, "registeredIn": "NC", "publiclyHeld": false, "smallBusiness": true, "taxExempt": false, "currency": "USD", "estimatedAnnualRevenue": "from1to10Million", "estimatedMonthlyAmounts": { "sentWire": "moreThanOneMillion", "receivedWire": "oneHundredThousandToOneMillion", "mobileCheckDeposit": "upToOneHundredThousand", "receivedAch": "upToOneHundredThousand", "sentAch": "moreThanOneMillion" }, "type": "corporation", "subtype": "soleProprietorship", "employeeCountLowerBound": 1, "employeeCountUpperBound": 1, "countryOfOperations": "US", "physicalLocationsCount": "under10", "mobileCheckDepositEnabled": true, "achEnabled": true, "authorizedSigners": [], "beneficialOwners": [], "createdAt": "2018-04-17T10:04:46.375Z", "updatedAt": "2018-04-17T10:12:58.375Z", "_links": { "self": { "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c" }, "apiture:deactivate": { "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c" } }, "_embedded": {} } }, "businessVerifications": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "businessVerifications": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/businessVerification" } } }, "example": { "businessVerifications": [ { "state": "failed", "completedAt": "2018-04-17T10:04:46.375Z", "type": "verificationReport", "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_links": { "apiture:verificationReport": { "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c" } } }, { "state": "passed", "completedAt": "2018-04-17T10:04:46.375Z", "type": "administratorApproval", "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_links": { "apiture:approval": { "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c" } } } ] } } ] }, "approval": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/updateApproval" }, { "type": "object", "properties": { "reason": { "description": "elided.", "type": "string", "maxLength": 512 }, "createdAt": { "description": "elided.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "elided.", "type": "string", "format": "date-time" }, "_embedded": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/approvalEmbeddedObjects" } ] } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json", "reason": "Invalid U.S. Address", "createdAt": "2018-04-17T10:04:46.375Z", "updatedAt": "2018-04-17T10:12:58.375Z", "_links": { "self": { "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c" }, "apiture:approvalType": { "href": "/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd" }, "apiture:target": { "href": "/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe" } }, "_embedded": { "approvalType": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json", "_links": { "self": { "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c" } }, "name": "governmentId", "label": "Government Issued ID", "description": "elided." } } } }, "transferAccount": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "accountTitle": { "description": "elided.", "maxLength": 512, "type": "string", "example": "John Smith" }, "title": "elided.", "institutionName": { "description": "elided.", "type": "string", "minLength": 2, "maxLength": 128, "example": "3rd Party Bank", "readOnly": true }, "routingNumber": { "description": "elided.", "type": "string", "minLength": 9, "maxLength": 9, "example": "021000021", "readOnly": true }, "accountNumbers": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/accountNumbers" } ], "readOnly": true }, "ifxType": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/ifxType" } ], "readOnly": true } } } ] }, "abstractRequest": { "title": "elided.", "description": "elided.", "properties": { "_links": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/links" } ] }, "_embedded": { "description": "elided.", "type": "object" }, "_profile": { "description": "elided.", "type": "string", "format": "uri" } }, "example": { "_profile": "{uri of resource profile.json}", "_links": { "self": { "href": "{uri of current resource}" } } } }, "abstractResource": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractRequest" }, { "type": "object", "properties": { "_error": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/error" } ] } } } ], "example": { "_profile": "{uri of resource profile.json}", "_links": { "self": { "href": "{uri of current resource}" } } } }, "collection": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "count": { "description": "elided.", "type": "integer" }, "start": { "description": "elided.", "type": "integer" }, "limit": { "description": "elided.", "type": "integer" }, "name": { "description": "elided.", "type": "string" } } } ] }, "contact": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/summaryContact" }, { "type": "object", "properties": { "attributes": { "type": "object", "description": "elided." }, "createdAt": { "description": "elided.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "elided.", "type": "string", "format": "date-time" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json", "firstName": "John", "middleName": "Daniel", "lastName": "Smith", "preferredName": "John", "suffix": "MD", "identification": [ { "type": "taxId", "value": "111-11-1111" } ], "emailAddresses": [ { "_id": "ea1", "value": "api@apiture.com", "type": "personal" }, { "_id": "ek3", "value": "support@apiture.com", "type": "work" } ], "preferredEmailAddressId": "ea1", "phones": [ { "_id": "pa1", "type": "home", "number": "(555) 555-5555" }, { "_id": "da6", "type": "mobile", "number": "(999) 555-5555" } ], "preferredPhoneId": "pa1", "birthdate": "1974-10-27", "citizenship": [ { "countryCode": "US", "state": "citizen" } ], "residencyStatus": "resident", "occupation": "officeAndAdministrativeSupport", "addresses": [ { "_id": "ha1", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "_id": "wa1", "type": "work", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "preferredMailingAddressId": "ha1", "identityVerification": { "provider": "IDology", "sessionId": "123456", "scoredAt": "2019-09-13T13:06:52.078Z", "score": "passed", "state": "verified" }, "yearsAtAddress": 3, "mailingDifferentAddress": false, "kycAnswers": { "citizen": true, "permanentResident": true, "w9Withholdings": false, "employmentStatus": "fullTime", "occupation": "officeAndAdministrativeSupport", "foreignPoliticalFigure": false, "countryPoliticalFigure": "N/A", "familyOfPoliticalFigure": false }, "state": "active", "createdAt": "2018-04-17T10:04:46.375Z", "updatedAt": "2018-04-17T10:12:58.375Z", "_links": { "self": { "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c" }, "apiture:deactivate": { "href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "summaryUser": { "title": "elided.", "description": "elided.", "allOf": [ { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "customerId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 100, "readOnly": true, "example": "00047294723672" } } }, { "$ref": "#/definitions/userFields" }, { "$ref": "#/definitions/abstractResource" } ] }, "role": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/updateRole" }, { "type": "object", "properties": { "createdAt": { "description": "elided.", "type": "string", "format": "date-time", "readOnly": true } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json", "_links": { "self": { "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c" } }, "name": "primaryUser", "label": "Primary User", "createdAt": "2018-02-01T13:07:01.375Z", "description": "elided." } }, "contactVerification": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "verifications": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/identityHistoryItem" } } } } ], "example": { "_links": { "apiture:user": { "href": "/users/users/6da5ccc7-727a-4256-bdd4-74023ae349c3" } }, "verifications": [ { "type": "fraudRiskReport", "_links": { "self": { "href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5" } }, "state": "passed", "createdAt": "2018-01-12T10:15:17Z" }, { "type": "quiz", "_links": { "self": { "href": "/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31" } }, "state": "passed", "createdAt": "2018-01-12T10:19:41Z" } ] } }, "consent": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/summaryConsent" } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/consents/consent/v1.0.0/profile.json", "document": { "uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content", "contentType": "application/pdf", "revisionId": "2019:1.02.0", "revisedAt": "2019-07-23T08:26:45.375Z" }, "state": "given", "givenAt": "2019-07-23T13:27:34.375Z", "type": "productTermsAndConditions", "userId": "5a5e834c-a7bd-401c", "contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a", "_links": { "self": { "href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c" }, "apiture:revoke": { "href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c" }, "apiture:rescind": { "href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "fraudRiskReport": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "$ref": "#/definitions/identityVerificationFields" }, { "type": "object", "properties": { "type": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/identityVerificationType" } ], "readOnly": true }, "inputs": { "$ref": "#/definitions/fraudRiskReportInputs" }, "outputs": { "$ref": "#/definitions/fraudRiskReportOutputs" } } } ], "example": { "_profile": "https://api.apiture.com/schemas/identity/fraudRiskReport/v2.0.0/profile.json", "_links": { "self": { "href": "/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5" }, "apiture:user": { "href": "/users/users/6da5ccc7-727a-4256-bdd4-74023ae349c3" } }, "_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5", "type": "fraudRiskReport", "inputs": { "identity": { "_profile": "https://api.apiture.com/schemas/identity/identity/v2.0.0/profile.json", "taxId": "*****3333", "firstName": "John", "lastName": "Smith", "address1": "1741 Tiburon Dr", "city": "Wilmington", "region": "NC", "postalCode": "28403", "phone": "555-555-5555", "birthdate": "1940-10-15", "email": "api@apiture.com", "ipAddress": "127.0.0.1" } }, "outputs": { "state": "passedWithRiskFactors", "fraudRiskCategories": [ { "type": "personalInfoDoesNotMatch", "description": "elided." }, { "type": "addressIsHighRisk", "description": "elided." }, { "type": "addressIsPOBoxOrNonApproved", "description": "elided." }, { "type": "identityOnGovernmentWatchlist", "description": "elided." }, { "type": "ipRestricted", "description": "elided." }, { "type": "emailRestricted", "description": "elided." }, { "type": "nonStandardTaxId", "description": "elided." }, { "type": "ageRestricted", "description": "elided." } ], "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.XbPfbIHMI6arZ3Y922BhjWgQzWXcXNrz0ogtVhfEd2o" } } }, "verificationReport": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "$ref": "#/definitions/summaryVerificationReport" }, { "type": "object", "properties": { "createdAt": { "description": "elided.", "type": "string", "format": "date-time" }, "_embedded": { "description": "elided.", "type": "object" }, "input": { "$ref": "#/definitions/createVerificationReport" }, "reportScoringSummary": { "$ref": "#/definitions/verificationReportScoringSummary" }, "reportResults": { "description": "elided.", "type": "object" } } } ], "example": { "createdAt": "2018-04-17T10:04:46.375Z", "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_embedded": {}, "input": { "businessName": "ABC EXAMPLE CO.", "phone": "555-555-1234", "identification": [ { "type": "taxId", "value": "12-347894309" } ], "authorizedSigners": [ { "firstName": "Jane", "lastName": "Doe", "identification": [ { "type": "taxId", "value": "121-34-5431" } ], "birthdate": "1980-12-01", "email": "email@email.com" } ], "addresses": [ { "addressLine1": "3212 N. 2nd Ave.", "city": "Wilmington", "regionCode": "NC", "postalCode": "28412" } ] }, "reportScoringSummary": { "transactionId": "578490325jk439834yuf43", "state": "failed", "businessVerification": [ { "value": 40, "description": "elided." } ], "businessRiskFactors": [ { "riskCode": "20", "description": "elided." }, { "riskCode": "21", "description": "elided." } ], "comprehensiveVerificationScores": [ { "inputRepNumber": "1", "score": 20, "description": "elided." } ], "authorizedRepresentativeRiskFactors": [ { "riskCode": "81", "description": "elided." }, { "riskCode": "25", "description": "elided." } ] }, "reportResults": {} } }, "externalAccountState": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "pending", "verifying", "failed", "active", "inactive", "frozen", "closed", "underReview" ], "example": "active" }, "configurationSchemaValue": { "title": "elided.", "description": "elided." }, "configurationGroupSummary": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "name": { "description": "elided.", "type": "string", "maxLength": 48, "minLength": 1, "pattern": "[a-zA-Z][-\\w_]*", "example": "transfers" }, "label": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1, "example": "Transfers Configuration" }, "description": "elided." } } ], "example": { "_profile": "https://api.apiture.com/schemas/configurations/configurationGroupSummary/v2.0.0/profile.json", "_links": { "self": { "href": "/configurations/groups/basic" } }, "name": "basic", "label": "Basic Settings", "description": "elided." } }, "productFields": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/productState" }, { "type": "object", "properties": { "name": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1 }, "label": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1 }, "description": "elided.", "code": { "description": "elided.", "type": "string", "maxLength": 64 }, "newAccountAvailability": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/newAccountAvailability" } ] }, "category": { "description": "elided.", "type": "string", "example": "Savings" }, "rate": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/rate" } ] }, "revision": { "description": "elided.", "type": "string" }, "ifxType": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/ifxType" } ] }, "target": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/productTarget" } ] } } } ] }, "revisionEffectiveInterval": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "effectiveStartAt": { "description": "elided.", "type": "string", "format": "date-time" }, "effectiveEndAt": { "description": "elided.", "type": "string", "format": "date-time" } } }, "timeDeposit": { "title": "elided.", "description": "elided.", "properties": { "maturityPolicy": { "$ref": "#/definitions/maturityPolicy" }, "minimumTerm": { "description": "elided.", "type": "string", "format": "period", "example": "P31D" }, "maximumTerm": { "description": "elided.", "type": "string", "format": "period", "example": "P31D" }, "fees": { "description": "elided.", "type": "string", "format": "period" } } }, "constraints": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "transactionTypes": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/transactionTypes" } ], "default": [ "debit", "credit" ] }, "minimumBalance": { "description": "elided.", "type": "string", "example": "500.00" }, "minimumFundingAmount": { "description": "elided.", "type": "string", "example": "500.00" }, "maximumFundingAmount": { "description": "elided.", "type": "string", "example": "2500.00" }, "minimumTransferAmount": { "description": "elided.", "type": "string", "example": "25.00" }, "maximumTransferAmount": { "description": "elided.", "type": "string", "example": "10000.00" }, "maximumWithdrawalCount": { "description": "elided.", "type": "integer", "example": 6 }, "fundingTerm": { "description": "elided.", "type": "string", "format": "period", "example": "P30D" }, "depositsRestrictedAfterGracePeriod": { "description": "elided.", "type": "boolean", "default": true }, "depositsRestrictedAfterFunding": { "description": "elided.", "type": "boolean", "default": true }, "gracePeriod": { "description": "elided.", "type": "string", "format": "period", "example": "P14D" } } }, "summaryOrganization": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "$ref": "#/definitions/organizationFields" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "customerId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 100, "readOnly": true, "example": "000489353781" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json", "_links": { "self": { "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "authorizedSigners": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "items": { "description": "elided.", "type": "array", "minLength": 1, "items": { "$ref": "#/definitions/authorization" } } } } ] }, "beneficialOwners": { "title": "elided.", "description": "elided.", "required": [ "items" ], "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "items": { "description": "elided.", "type": "array", "maxLength": 10, "items": { "$ref": "#/definitions/beneficialOwner" } } } } ], "example": { "items": [ { "firstName": "William", "lastName": "Wellphunded", "addresses": [ { "addressLine1": "1234 S Front Street", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US", "type": "home" } ], "role": "Chief Financial Officer", "percentage": 35, "birthdate": {}, "identification": [ { "type": "taxId", "value": "111-11-1111" } ] } ], "_links": { "self": { "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c/beneficialOwners" } } } }, "links": { "title": "elided.", "description": "elided.", "type": "object", "additionalProperties": { "$ref": "#/definitions/link" } }, "businessVerification": { "title": "elided.", "description": "elided.", "properties": { "state": { "type": "string", "description": "elided.", "enum": [ "passed", "failed" ] }, "completedAt": { "description": "elided.", "type": "string", "format": "date-time" }, "type": { "description": "elided.", "type": "string", "enum": [ "verificationReport", "administratorApproval" ] }, "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "_links": { "$ref": "#/definitions/links" } } }, "identityHistoryItem": { "title": "elided.", "description": "elided.", "type": "object", "required": [ "state", "createdAt" ], "properties": { "_links": { "$ref": "#/definitions/links" }, "state": { "$ref": "#/definitions/identityVerificationState" }, "type": { "$ref": "#/definitions/identityVerificationType" }, "createdAt": { "description": "elided.", "type": "string", "format": "date-time" }, "expiredAt": { "description": "elided.", "type": "string", "format": "date-time" } }, "example": { "state": "passed", "createdAt": "2019-11-21T08:43:54.375Z", "type": "quiz", "_links": { "apiture:user": { "href": "https://api.example.bank/users/users/d77bef0b-c75c-4192-ba88-278b9ce4063b" } } } }, "summaryContact": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/contactVerificationFields" }, { "$ref": "#/definitions/identifiedContact" }, { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "state": { "description": "elided.", "readOnly": true, "allOf": [ { "$ref": "#/definitions/contactState" } ] }, "_id": { "description": "elided.", "readOnly": true, "type": "string" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json", "firstName": "John", "middleName": "Daniel", "lastName": "Smith", "preferredName": "John", "suffix": "MD", "identification": [ { "type": "taxId", "value": "111-11-1111" } ], "emailAddresses": [ { "_id": "ea1", "value": "api@apiture.com", "type": "personal" }, { "_id": "ek3", "value": "support@apiture.com", "type": "work" } ], "preferredEmailAddressId": "ea1", "phones": [ { "_id": "pa1", "type": "home", "number": "(555) 555-5555" }, { "_id": "da6", "type": "mobile", "number": "(999) 555-5555" } ], "preferredPhoneId": "pa1", "birthdate": "1974-10-27", "citizenship": [ { "countryCode": "US", "state": "citizen" } ], "residencyStatus": "resident", "occupation": "officeAndAdministrativeSupport", "addresses": [ { "_id": "ha1", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "_id": "wa1", "type": "work", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "preferredMailingAddressId": "ha1", "identityVerification": { "provider": "IDology", "sessionId": "123456", "scoredAt": "2019-09-13T13:06:52.078Z", "score": "passed", "state": "verified" }, "yearsAtAddress": 3, "mailingDifferentAddress": false, "kycAnswers": { "citizen": true, "permanentResident": true, "w9Withholdings": false, "employmentStatus": "fullTime", "occupation": "officeAndAdministrativeSupport", "foreignPoliticalFigure": false, "countryPoliticalFigure": "N/A", "familyOfPoliticalFigure": false }, "state": "active", "_links": { "self": { "href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "attributeValue": { "title": "elided.", "description": "elided." }, "identityVerificationFields": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "properties": { "_id": { "type": "string", "description": "elided.", "readOnly": true }, "createdAt": { "description": "elided.", "type": "string", "format": "date-time" }, "expiresAt": { "description": "elided.", "type": "string", "format": "date-time" } } } ] }, "identityVerificationType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "fraudRiskReport", "quiz", "adminApproval" ] }, "fraudRiskReportInputs": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "identity": { "$ref": "#/definitions/identity" } } }, "fraudRiskReportOutputs": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/outputs" }, { "properties": { "providerReportId": { "type": "string", "description": "elided." }, "state": { "$ref": "#/definitions/fraudRiskReportState" }, "fraudRiskCategories": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/fraudRiskCategory" } } } } ] }, "userFields": { "title": "elided.", "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/identifiedContact" }, { "$ref": "#/definitions/contactName" }, { "$ref": "#/definitions/simpleContactFields" }, { "$ref": "#/definitions/userVerificationFields" }, { "type": "object", "properties": { "username": { "description": "elided.", "type": "string" }, "state": { "description": "elided.", "type": "string", "enum": [ "active", "inactive", "locked", "frozen", "merged", "removed" ] }, "addresses": { "description": "elided.", "type": "array", "items": { "type": "object", "$ref": "#/definitions/userAddress" }, "readOnly": true }, "preferredMailingAddressId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4, "readOnly": true }, "phoneNumbers": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/userPhoneNumber" }, "readOnly": true }, "preferredPhoneId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4, "readOnly": true }, "emailAddresses": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/userEmailAddress" }, "readOnly": true }, "preferredEmailAddressId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4, "readOnly": true } } } ], "example": { "username": "Johnny1733", "firstName": "John", "middleName": "Daniel", "lastName": "Smith", "preferredName": "John", "identification": [ { "value": "111-11-1111", "type": "taxId", "emailAddresses": [ { "_id": "pe0", "type": "personal", "value": "johnny1733@example.com" }, { "_id": "we0", "type": "work", "value": "support@apiture.com" } ] } ], "phones": [ { "_id": "hp0", "type": "home", "number": "(555) 555-5555" }, { "_id": "mp0", "type": "mobile", "number": "(999) 555-5555" } ], "birthdate": "1974-10-27", "citizenship": [ { "countryCode": "US", "state": "citizen" } ], "occupation": "officeAndAdministrativeSupport", "addresses": [ { "_id": "ha0", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "_id": "ha1", "type": "home", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "state": "active", "attributes": {}, "preferredContactMethod": "email" } }, "summaryConsent": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/consentFields" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/consentStates" } ], "readOnly": true }, "givenAt": { "description": "elided.", "type": "string", "format": "date-time", "readOnly": true }, "requestRevokedAt": { "description": "elided.", "type": "string", "format": "date-time", "readOnly": true }, "requestRescindedAt": { "description": "elided.", "type": "string", "format": "date-time", "readOnly": true } } }, { "$ref": "#/definitions/abstractResource" } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/consents/summaryConsent/v1.0.0/profile.json", "document": { "uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content", "contentType": "application/pdf", "revisedAt": "2019-07-23T08:26:45.375Z" }, "type": "productTermsAndConditions", "userId": "5a5e834c-a7bd-401c", "state": "pending", "contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a", "_links": { "self": { "href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "error": { "title": "elided.", "description": "elided.", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "elided." }, "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "statusCode": { "description": "elided.", "type": "integer", "minimum": 100, "maximum": 599, "example": 422 }, "type": { "type": "string", "description": "elided." }, "occurredAt": { "type": "string", "format": "date-time", "description": "elided.", "example": "2018-02-02T03:37:15.375Z" }, "attributes": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/attributes" } ] }, "remediation": { "type": "string", "description": "elided." }, "errors": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/error" } }, "_links": { "$ref": "#/definitions/links" } }, "example": { "_id": "2eae46e1575c0a7b0115a4b3", "message": "Descriptive error message...", "statusCode": 422, "type": "errorType1", "remediation": "Remediation string...", "occurredAt": "2018-01-25T05:50:52.375Z", "errors": [ { "_id": "ccdbe2c5c938a230667b3827", "message": "An optional embedded error" }, { "_id": "dbe9088dcfe2460f229338a3", "message": "Another optional embedded error" } ], "_links": { "describedby": { "href": "https://developer.apiture.com/errors/errorType1" } } } }, "configurationValue": { "title": "elided.", "description": "elided." }, "accountNumbers": { "title": "elided.", "description": "elided.", "properties": { "masked": { "description": "elided.", "type": "string", "minLength": 8, "maxLength": 32, "readOnly": true, "example": "*************3210" }, "full": { "description": "elided.", "type": "string", "minLength": 4, "maxLength": 17, "example": "9876543210", "readOnly": true } } }, "ifxType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "CCA", "CDA", "CLA", "CMA", "DDA", "EQU", "GLA", "ILA", "INV", "IRA", "IRL", "LOC", "MLA", "MMA", "PBA", "PPA", "RWD", "SDA" ] }, "updateApproval": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/summaryApproval" }, { "type": "object", "properties": { "attributes": { "type": "object", "description": "elided." } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json" } }, "approvalEmbeddedObjects": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "approvalType": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/summaryApprovalType" } ] }, "target": { "description": "elided.", "type": "object" } } }, "summaryVerificationReport": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" }, "reportScoringSummary": { "$ref": "#/definitions/verificationReportScoringSummary" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/businessVerifications/verificationReports/v1.0.0/profile.json", "_links": { "self": { "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "createVerificationReport": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/verificationRequestFields" }, { "$ref": "#/definitions/abstractRequest" } ], "example": { "_profile": "https://production.api.apiture.com/schemas/businessVerifications/createVerificationReport/v2.0.0/profile.json", "businessName": "ABC EXAMPLE CO.", "phone": "555-555-1234", "identification": [ { "type": "taxId", "value": "12-347894309" } ], "attributes": {}, "addresses": [ { "addressLine1": "3212 N. 2nd Ave.", "city": "Wilmington", "regionCode": "NC", "postalCode": "28412" } ], "authorizedSigners": [ { "firstName": "Jane", "lastName": "Doe", "identification": [ { "type": "taxId", "value": "121-34-5431" } ], "birthdate": "1980-12-01", "email": "email@email.com" } ] } }, "verificationReportScoringSummary": { "title": "elided.", "description": "elided.", "properties": { "transactionId": { "description": "elided.", "type": "string" }, "state": { "type": "string", "description": "elided.", "enum": [ "passed", "failed" ] }, "businessVerifications": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/businessVerificationScore" } }, "businessRiskFactors": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/riskFactor" } }, "comprehensiveVerificationScores": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/comprehensiveVerificationScore" } }, "authorizedRepresentativeRiskFactors": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/riskFactor" } } } }, "updateRole": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/summaryRole" } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json", "label": "primary user", "name": "primaryUser", "description": "elided." } }, "organizationFields": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/simpleOrganization" }, { "type": "object", "properties": { "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/organizationState" } ] }, "tradeName": { "type": "string", "description": "elided." }, "governmentOwned": { "description": "elided.", "type": "boolean" }, "publiclyHeld": { "description": "elided.", "type": "boolean" }, "smallBusiness": { "description": "elided.", "type": "boolean" }, "taxExempt": { "description": "elided.", "type": "boolean" }, "employeeCountRange": { "description": "elided.", "type": "string" }, "employeeCountLowerBound": { "description": "elided.", "type": "integer", "readOnly": true, "minimum": 1 }, "employeeCountUpperBound": { "description": "elided.", "type": "number", "readOnly": true, "maximum": 20000000 }, "homeUrl": { "description": "elided.", "type": "string" }, "industry": { "description": "elided.", "type": "string" }, "countryOfOperations": { "type": "string", "description": "elided.", "minLength": 2, "maxLength": 2 }, "regulatory": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/regulatory" } ] }, "currency": { "description": "elided.", "type": "string", "minLength": 3, "maxLength": 3 }, "mobileCheckDepositEnabled": { "description": "elided.", "type": "boolean" }, "achEnabled": { "description": "elided.", "type": "boolean" }, "estimatedMonthlyAmounts": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/estimatedMonthlyAmounts" } ] }, "accountPurpose": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/accountPurpose" } ] }, "registeredIn": { "description": "elided.", "type": "string", "example": "NC", "minLength": 2, "maxLength": 2, "pattern": "^[a-zA-Z]{2}$" } } } ], "example": { "name": "Smith's Auto Detailing", "label": "Smith's Detailing", "emailAddresses": [ { "type": "work", "value": "smitties-detailing@example.com" } ], "phones": [ { "type": "work", "number": "(555) 555-5555" }, { "type": "mobile", "number": "(999) 555-5555" } ], "addresses": [ { "type": "work", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "type": "work", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "establishedDate": "2009-07-09T", "identification": [ { "type": "taxId", "value": "00-9999999" } ], "state": "active", "currency": "USD", "estimatedAnnualRevenue": "from1to10Million", "estimatedMonthlyAmounts": { "sentWire": "moreThanOneMillion", "receivedWire": "oneHundredThousandToOneMillion", "mobileCheckDeposit": "upToOneHundredThousand", "receivedAch": "upToOneHundredThousand", "sentAch": "moreThanOneMillion" }, "physicalLocationsCount": "under10" } }, "transactionTypes": { "title": "elided.", "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/transactionType" } }, "beneficialOwner": { "title": "elided.", "description": "elided.", "required": [ "percentage", "contactId", "firstName", "lastName", "identification" ], "allOf": [ { "$ref": "#/definitions/simpleContact" }, { "type": "object", "properties": { "role": { "type": "string", "description": "elided." }, "percentage": { "description": "elided.", "type": "integer", "minimum": 0, "maximum": 100, "example": 25 }, "birthdate": { "description": "elided.", "type": "string", "format": "date" }, "contactId": { "type": "string", "description": "elided." } } } ], "example": { "firstName": "William", "lastName": "Wellphunded", "addresses": [ { "addressLine1": "1234 S Front Street", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US", "type": "home" } ], "identification": [ { "type": "taxId", "value": "111-11-1111" } ], "role": "Chief Financial Officer", "birthdate": {}, "percentage": 35, "contactId": "8bf04d7d-c1bd-4945-b0ac-40ef02bb3953" } }, "authorization": { "title": "elided.", "description": "elided.", "required": [ "type", "userId", "customerId", "firstName", "lastName", "citizen", "taxId", "addresses" ], "allOf": [ { "$ref": "#/definitions/individualIdentification" }, { "type": "object", "properties": { "userId": { "description": "elided.", "type": "string", "example": "bd9e7a93-32cc-435d-ac57-f21faa082318" }, "customerId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 100, "readOnly": true, "example": "00047294723672" }, "type": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/authorizationType" } ] }, "role": { "description": "elided.", "type": "string" } } } ], "example": { "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318", "customerId": "00047294723672", "type": "joint", "role": "Chief Financial Officer", "firstName": "John", "middleName": "Daniel", "lastName": "Smith", "taxId": "*****3333", "citizen": true, "addresses": [ { "_id": "ha5", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "id": "wa0", "type": "other", "label": "mailing", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "preferredMailingAddressId": "ha5", "emailAddress": "JohnDanielSmith@example.com" } }, "link": { "title": "elided.", "description": "elided.", "required": [ "href" ], "properties": { "href": { "type": "string", "format": "uri", "description": "elided." }, "type": { "type": "string", "description": "elided." }, "templated": { "type": "boolean", "description": "elided." }, "title": "elided.", "deprecation": { "type": "string", "format": "uri", "description": "elided." }, "profile": { "type": "string", "format": "uri", "description": "elided." } }, "example": { "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f", "title": "elided." } }, "outputs": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/verificationToken" } ] }, "fraudRiskReportState": { "title": "elided.", "type": "string", "description": "elided.", "enum": [ "passed", "passedWithRiskFactors", "failed" ] }, "fraudRiskCategory": { "title": "elided.", "description": "elided.", "properties": { "type": { "$ref": "#/definitions/fraudRiskCategoryType" }, "description": "elided.", "message": { "description": "elided.", "type": "string" } }, "example": { "type": "personalInfoDoesNotMatch", "description": "elided.", "message": "ZIP code located does not match the ZIP code submitted." } }, "identity": { "title": "elided.", "description": "elided.", "required": [ "taxId", "firstName", "lastName", "address1", "city", "region", "postalCode", "phone", "birthdate" ], "properties": { "taxId": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1, "example": "112-22-3333" }, "firstName": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1 }, "lastName": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1 }, "address1": { "description": "elided.", "type": "string", "maxLength": 512, "minLength": 1 }, "address2": { "description": "elided.", "type": "string", "maxLength": 512, "minLength": 1 }, "city": { "description": "elided.", "type": "string", "maxLength": 64, "minLength": 1 }, "region": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1 }, "postalCode": { "description": "elided.", "type": "string", "maxLength": 32, "minLength": 1 }, "phone": { "description": "elided.", "type": "string", "maxLength": 32, "minLength": 1 }, "birthdate": { "description": "elided.", "type": "string", "format": "date", "pattern": "^([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))$", "maxLength": 10, "minLength": 10 }, "email": { "description": "elided.", "type": "string", "format": "email", "maxLength": 256 }, "ipAddress": { "description": "elided.", "type": "string", "format": "ipv4" } }, "example": { "taxId": "112-22-3333", "firstName": "John", "lastName": "Smith", "address1": "1741 Tiburon Dr", "city": "Wilmington", "region": "NC", "postalCode": "28403", "phone": 15555555555, "birthdate": "1940-10-15", "email": "api@apiture.com", "ipAddress": "127.0.0.1" } }, "identifiedContact": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/simpleContact" }, { "$ref": "#/definitions/identifiedContactFields" } ] }, "contactName": { "title": "elided.", "description": "elided.", "properties": { "firstName": { "description": "elided.", "type": "string" }, "middleName": { "description": "elided.", "type": "string" }, "lastName": { "description": "elided.", "type": "string" } }, "example": { "firstName": "John", "middleName": "Daniel", "lastName": "Smith" } }, "simpleContactFields": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "prefix": { "description": "elided.", "type": "string", "maxLength": 20 }, "suffix": { "description": "elided.", "type": "string", "maxLength": 20 }, "preferredName": { "description": "elided.", "type": "string" }, "identification": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/identification" } }, "preferredContactMethod": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/preferredContactMethod" } ] } } }, "userVerificationFields": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "kycAnswers": { "description": "elided.", "readOnly": true, "allOf": [ { "$ref": "#/definitions/kycAnswers" } ] }, "identityVerification": { "description": "elided.", "type": "object", "readOnly": true, "allOf": [ { "$ref": "#/definitions/identityVerification" } ] } } }, "userAddress": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/address" }, { "type": "object", "properties": { "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/profileItemState" } ] } } }, { "$ref": "#/definitions/abstractResource" } ], "example": { "_id": "ha1", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US", "state": "approved", "_links": { "self": { "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1" } } } }, "userPhoneNumber": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/phoneNumber" }, { "type": "object", "properties": { "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/profileItemState" } ] } } }, { "$ref": "#/definitions/abstractResource" } ], "example": { "_id": "hp1", "_profile": "https://api.apiture.com/schemas/users/userPhoneNumber/v1.0.0/profile.json", "type": "home", "number": "555-555-5555", "state": "approved", "_links": { "self": { "href": "/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1" } } } }, "userEmailAddress": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/typedEmailAddress" }, { "type": "object", "properties": { "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/profileItemState" } ] } } }, { "$ref": "#/definitions/abstractResource" } ], "example": { "_id": "pe1", "_profile": "https://api.apiture.com/schemas/users/userEmailAddress/v1.0.0/profile.json", "type": "personal", "number": "555-555-5555", "state": "approved", "_links": { "self": { "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1" }, "delete": { "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1" }, "apiture:setAsPreferred": { "href": "/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1" } } } }, "productState": { "title": "elided.", "description": "elided.", "properties": { "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/prodState" } ] } } }, "newAccountAvailability": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "available", "notAvailable" ] }, "rate": { "title": "elided.", "description": "elided.", "properties": { "value": { "description": "elided.", "type": "string", "example": "1.40" }, "benchmark": { "description": "elided.", "type": "string", "example": "prime" }, "compoundPeriod": { "description": "elided.", "type": "string", "example": "P7D" }, "accrualType": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/accrualType" } ] }, "adjustmentPeriod": { "description": "elided.", "type": "string", "example": "P1D" }, "type": { "description": "elided.", "type": "string", "allOf": [ { "$ref": "#/definitions/interestRateType" } ] } }, "example": { "value": "1.40", "type": "apr" } }, "productTarget": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "personal", "business" ] }, "summaryApprovalType": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "$ref": "#/definitions/approvalTypeFields" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/approvals/approvalTypes/v1.0.0/profile.json", "_links": { "self": { "href": "/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "businessVerificationScore": { "title": "elided.", "description": "elided.", "properties": { "value": { "description": "elided.", "type": "string" }, "description": "elided." } }, "riskFactor": { "title": "elided.", "description": "elided.", "properties": { "riskCode": { "description": "elided.", "type": "string" }, "description": "elided." } }, "comprehensiveVerificationScore": { "title": "elided.", "description": "elided.", "properties": { "inputRepNumber": { "description": "elided.", "type": "string" }, "score": { "description": "elided.", "type": "integer" }, "description": "elided." } }, "verificationRequestFields": { "title": "elided.", "description": "elided.", "properties": { "businessName": { "description": "elided.", "type": "string", "maxLength": 512, "minLength": 1 }, "alternateBusinessName": { "description": "elided.", "type": "string", "maxLength": 512, "minLength": 1 }, "phone": { "description": "elided.", "type": "string", "maxLength": 32, "minLength": 1 }, "identification": { "$ref": "#/definitions/identificationModel" }, "authorizedSigners": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/authorizedSigner" } }, "addresses": { "description": "elided.", "type": "array", "items": { "type": "object", "$ref": "#/definitions/address" } }, "attributes": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/attributes" } ] } }, "example": { "businessName": "ABC EXAMPLE CO.", "phone": "555-555-1234", "identification": [ { "type": "taxId", "value": "12-347894309" } ], "attributes": {}, "addresses": [ { "addressLine1": "3212 N. 2nd Ave.", "city": "Wilmington", "regionCode": "NC", "postalCode": "28412" } ], "authorizedSigners": [ { "firstName": "Jane", "lastName": "Doe", "identification": [ { "type": "taxId", "value": "121-34-5431" } ], "birthdate": "1980-12-01", "email": "email@email.com" } ] } }, "summaryApproval": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/abstractResource" }, { "$ref": "#/definitions/approvalFields" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/approvals/approvals/v1.0.0/profile.json", "_links": { "self": { "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "maturityPolicy": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "rolloverPrincipalAndInterest", "transferPrincipalAndInterest", "rolloverPrincipalAndTransferInterest", "holdPrincipalAndInterest", "partialTransfer" ] }, "contactVerificationFields": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "kycAnswers": { "description": "elided.", "type": "object" }, "identityVerificationStatus": { "description": "elided.", "type": "string", "readOnly": true, "enum": [ "verified", "unverified" ] }, "identityVerification": { "description": "elided.", "type": "object", "allOf": [ { "$ref": "#/definitions/identityVerification" } ] } }, "example": { "firstName": "John", "middleName": "Daniel", "lastName": "Smith", "preferredName": "John", "suffix": "MD", "identification": [ { "type": "taxId", "value": "111-11-1111" } ], "emailAddresses": [ { "_id": "ea1", "value": "api@apiture.com", "type": "personal" }, { "_id": "ek3", "value": "support@apiture.com", "type": "work" } ], "preferredEmailAddressId": "ea1", "phones": [ { "_id": "pa1", "type": "home", "number": "(555) 555-5555" }, { "_id": "da6", "type": "mobile", "number": "(999) 555-5555" } ], "preferredPhoneId": "pa1", "birthdate": "1974-10-27", "citizenship": [ { "countryCode": "US", "state": "citizen" } ], "residencyStatus": "resident", "occupation": "officeAndAdministrativeSupport", "addresses": [ { "_id": "ha1", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "_id": "wa1", "type": "work", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "preferredMailingAddressId": "ha1", "identityVerification": { "provider": "IDology", "sessionId": "123456", "scoredAt": "2019-09-13T13:06:52.078Z", "score": "passed", "state": "verified" }, "yearsAtAddress": 3, "mailingDifferentAddress": false, "kycAnswers": { "citizen": true, "permanentResident": true, "w9Withholdings": false, "employmentStatus": "fullTime", "occupation": "officeAndAdministrativeSupport", "foreignPoliticalFigure": false, "countryPoliticalFigure": "N/A", "familyOfPoliticalFigure": false }, "state": "active" } }, "contactState": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "inactive", "active", "merged", "removed" ] }, "consentFields": { "title": "elided.", "description": "elided.", "properties": { "document": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/document" } ] }, "type": { "description": "elided.", "type": "string" }, "contextUri": { "description": "elided.", "type": "string", "format": "uri", "maxLength": 2048 }, "userId": { "description": "elided.", "type": "string" } } }, "consentStates": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "pending", "given", "stale", "rescinded", "revoked" ] }, "identityVerificationState": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "passed", "failed", "passedWithRiskFactors", "pending", "asked", "identityServiceFailure", "scoring", "expired" ] }, "summaryRole": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/roleFields" }, { "$ref": "#/definitions/abstractResource" }, { "type": "object", "properties": { "_id": { "description": "elided.", "readOnly": true, "type": "string" } } } ], "example": { "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c", "_profile": "https://api.apiture.com/schemas/associations/role/v1.0.0/profile.json", "name": "primaryUser", "label": "Primary User", "description": "elided.", "_links": { "self": { "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c" } } } }, "simpleContact": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/contactName" }, { "$ref": "#/definitions/addresses" }, { "$ref": "#/definitions/emailAddresses" }, { "$ref": "#/definitions/phoneNumbers" }, { "$ref": "#/definitions/simpleContactFields" } ], "example": { "firstName": "John", "middleName": "Daniel", "lastName": "Smith", "preferredName": "John", "suffix": "MD", "identification": [ { "type": "taxId", "value": "*****3333" } ], "addresses": [ { "_id": "ha1", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" } ], "preferredMailingAddressId": "ha1", "emailAddresses": [ { "id": "pe0", "value": "api@apiture.com", "type": "personal" }, { "id": "wp1", "value": "support@apiture.com", "type": "work" } ], "preferredEmailAddressId": "pe0", "phones": [ { "_id": "hp1", "type": "home", "number": "(555) 555-5555" }, { "_id": "mp1", "type": "mobile", "number": "(999) 555-5555" } ], "preferredPhoneId": "hp1", "preferredContactMethod": "email" } }, "simpleOrganization": { "title": "elided.", "description": "elided.", "allOf": [ { "type": "object", "properties": { "name": { "description": "elided.", "type": "string" }, "label": { "description": "elided.", "type": "string" }, "type": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/organizationType" } ] }, "subtype": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/organizationSubtype" } ] }, "identification": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/organizationIdentification" } }, "addresses": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/organizationAddress" } }, "phones": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/organizationPhoneNumber" } }, "emailAddresses": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/organizationEmailAddress" } }, "preferredEmailAddressId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4, "readOnly": true }, "preferredPhoneId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4, "readOnly": true }, "preferredMailingAddressId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4, "readOnly": true }, "establishedDate": { "description": "elided.", "type": "string", "format": "date" } } } ], "example": { "name": "Smith's Auto Detailing", "label": "Smith's Detailing", "emailAddresses": [ { "type": "work", "value": "smitties-detailing@example.com" } ], "identification": [ { "type": "taxId", "value": "00-9999999" } ], "phones": [ { "type": "work", "number": "(555) 555-5555" }, { "type": "mobile", "number": "(999) 555-5555" } ], "addresses": [ { "type": "work", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "type": "work", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "establishedDate": "2009-07-09T" } }, "organizationState": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "pending", "inactive", "active", "merged", "removed" ] }, "regulatory": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "estimatedAnnualRevenue": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/estimatedAnnualRevenue" } ] }, "atmOperator": { "description": "elided.", "type": "boolean" }, "charity": { "description": "elided.", "type": "boolean" }, "cashesChecksMoreThan1000Usd": { "description": "elided.", "type": "boolean" }, "internetGamblingIncorporated": { "description": "elided.", "type": "boolean" }, "marijuanaBusiness": { "description": "elided.", "type": "boolean" }, "moneyOrderMoreThan1000Usd": { "description": "elided.", "type": "boolean" }, "thirdPartyBenefit": { "description": "elided.", "type": "boolean" }, "transmitBehalfOfCustomer": { "description": "elided.", "type": "boolean" }, "virtualCurrency": { "description": "elided.", "type": "boolean" }, "intermediaryServices": { "description": "elided.", "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/intermediaryServices" } }, "subjectToWithholdings": { "description": "elided.", "type": "boolean", "default": false } }, "additionalProperties": { "$ref": "#/definitions/regulatoryValue" } }, "estimatedMonthlyAmounts": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "percentGrossRevenue": { "title": "elided.", "description": "elided.", "type": "string" }, "sentAch": { "description": "elided.", "type": "string", "example": "upToOneHundredThousand" }, "receivedAch": { "description": "elided.", "type": "string", "example": "oneHundredThousandToOneMillion" }, "mobileCheckDeposit": { "description": "elided.", "type": "string", "example": "oneHundredThousandToOneMillion" }, "sentWire": { "description": "elided.", "type": "string", "example": "oneHundredThousandToOneMillion" }, "receivedWire": { "description": "elided.", "type": "string", "example": "moreThanOneMillion" } } }, "accountPurpose": { "title": "elided.", "x-apiuture-fragment": true, "description": "elided.", "type": "string", "enum": [ "unknown", "creditCardProcessing", "generalOperatingFunds", "lottery", "payroll", "savings", "other", "notApplicable" ] }, "fraudRiskCategoryType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "ipRestricted", "identityOnGovernmentWatchlist", "identityOnAlertList", "addressIsPOBoxOrNonApproved", "addressIsHighRisk", "ageRestricted", "nonStandardTaxId", "personalInfoDoesNotMatch", "emailRestricted" ] }, "individualIdentification": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/contactName" }, { "$ref": "#/definitions/addresses" }, { "type": "object", "properties": { "taxId": { "description": "elided.", "type": "string" }, "citizen": { "description": "elided.", "type": "boolean" }, "emailAddress": { "description": "elided.", "type": "string", "format": "email" } } } ] }, "authorizationType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "primary", "joint", "authorizedSigner" ] }, "transactionType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "debit", "credit" ] }, "phoneNumber": { "title": "elided.", "description": "elided.", "type": "object", "required": [ "type", "number" ], "properties": { "type": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/phoneNumberType" } ] }, "number": { "description": "elided.", "type": "string", "example": "555-555-5555", "minLength": 8, "maxLength": 16 }, "label": { "description": "elided.", "type": "string", "example": "assistant", "maxLength": 32 }, "_id": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 8, "example": "ha5", "pattern": "^[-a-zA-Z0-9_]{1,8}$" } }, "example": { "_id": "hp1", "type": "home", "number": "555-555-5555" } }, "profileItemState": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "pending", "approved" ], "example": "approved" }, "kycAnswers": { "title": "elided.", "description": "elided.", "properties": { "citizen": { "description": "elided.", "type": "boolean" }, "permanentResident": { "description": "elided.", "type": "boolean" }, "w9Withholdings": { "description": "elided.", "type": "boolean" }, "employmentStatus": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/employmentStatus" } ] }, "foreignPoliticalFigure": { "title": "elided.", "description": "elided.", "type": "boolean", "default": false }, "countryPoliticalFigure": { "description": "elided.", "type": "string" }, "familyOfPoliticalFigure": { "title": "elided.", "description": "elided.", "type": "boolean" }, "foreignPoliticalFigureCountry": { "title": "elided.", "description": "elided.", "type": "string", "maxLength": 2 }, "foreignPoliticalFigureAssociation": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/foreignPoliticalFigureAssociation" } ] } } }, "identityVerification": { "title": "elided.", "description": "elided.", "properties": { "provider": { "title": "elided.", "description": "elided.", "type": "string" }, "sessionId": { "title": "elided.", "description": "elided.", "type": "string" }, "scoredAt": { "title": "elided.", "description": "elided.", "type": "string", "format": "date-time", "example": "2019-09-13T06:11:01.375Z" }, "score": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "passed", "failed", "expired" ] }, "state": { "title": "elided.", "description": "elided.", "type": "string", "readOnly": true, "enum": [ "verified", "unverified" ] } } }, "identifiedContactFields": { "title": "elided.", "description": "elided.", "type": "object", "properties": { "birthdate": { "description": "elided.", "type": "string", "format": "date" }, "citizenship": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/citizenship" } ] }, "residencyStatus": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/residencyStatus" } ] }, "occupation": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/occupation" } ] }, "otherOccupation": { "description": "elided.", "type": "string", "minLength": 4, "maxLength": 32 }, "yearsAtAddress": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/yearsAtAddress" } ] } } }, "typedEmailAddress": { "title": "elided.", "description": "elided.", "properties": { "value": { "description": "elided.", "type": "string", "format": "email", "minLength": 8, "maxLength": 120, "example": "JohnBankCustomer@example.com" }, "type": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/emailType" } ] }, "_id": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 8, "example": "ha3", "pattern": "^[-a-zA-Z0-9_]{1,8}$" } } }, "verificationToken": { "title": "elided.", "description": "elided.", "properties": { "token": { "type": "string", "description": "elided." } } }, "identification": { "title": "elided.", "description": "elided.", "type": "object", "required": [ "type", "value" ], "properties": { "value": { "description": "elided.", "type": "string" }, "type": { "description": "elided.", "type": "string", "enum": [ "taxId", "passportNumber" ] }, "expiration": { "description": "elided.", "type": "string", "format": "date" } }, "example": { "type": "taxId", "value": "112-22-3333", "expiration": {} } }, "preferredContactMethod": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "sms", "email", "other", "notApplicable" ] }, "approvalTypeFields": { "title": "elided.", "description": "elided.", "properties": { "name": { "description": "elided.", "type": "string" }, "label": { "description": "elided.", "type": "string" }, "description": "elided.", "domain": { "description": "elided.", "type": "string" }, "disallowedStates": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/disallowedState" } } }, "example": { "name": "governmentId", "label": "Government Issued ID", "description": "elided.", "disallowedStates": [ "waived", "canceled" ], "domain": "https://production.api.apiture.com/domains/approvals/documentRequirement" } }, "address": { "title": "elided.", "description": "elided.", "type": "object", "required": [ "addressLine1", "city", "regionCode", "postalCode" ], "properties": { "label": { "description": "elided.", "type": "string" }, "addressLine1": { "description": "elided.", "type": "string" }, "addressLine2": { "description": "elided.", "type": "string" }, "city": { "description": "elided.", "type": "string" }, "regionCode": { "description": "elided.", "type": "string", "example": "NC" }, "postalCode": { "description": "elided.", "type": "string", "example": "28401-5405" }, "countryCode": { "description": "elided.", "type": "string", "minLength": 2, "maxLength": 2 } } }, "accrualType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "compounding", "simple" ] }, "interestRateType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "apr", "apy" ], "example": "apr" }, "identificationModel": { "title": "elided.", "description": "elided.", "type": "array", "items": { "type": "object", "required": [ "type", "value" ], "properties": { "value": { "description": "elided.", "type": "string" }, "type": { "description": "elided.", "type": "string", "enum": [ "taxId", "dunsNumber" ] } } } }, "authorizedSigner": { "title": "elided.", "description": "elided.", "required": [ "firstName", "lastName" ], "properties": { "firstName": { "description": "elided.", "type": "string", "maxLength": 512, "minLength": 1 }, "lastName": { "description": "elided.", "type": "string", "maxLength": 512, "minLength": 1 }, "identification": { "$ref": "#/definitions/identificationModel" }, "birthdate": { "description": "elided.", "type": "string", "format": "date", "pattern": "^([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))$", "maxLength": 10, "minLength": 10 }, "email": { "description": "elided.", "type": "string", "maxLength": 512, "minLength": 1 } }, "example": { "firstName": "Jane", "lastName": "Doe", "identification": [ { "type": "taxId", "value": "121-34-5431" } ], "birthdat>": "1980-12-01", "email": "email@email.com" } }, "approvalFields": { "title": "elided.", "description": "elided.", "properties": { "label": { "description": "elided.", "type": "string" }, "description": "elided.", "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/approvalState" } ], "readOnly": true }, "done": { "description": "elided.", "type": "boolean", "readOnly": true }, "typeName": { "description": "elided.", "type": "string" }, "reviewedBy": { "description": "elided.", "type": "string" }, "reviewedAt": { "description": "elided.", "type": "string", "format": "date-time" } }, "example": { "state": "active", "done": true, "label": "Government Issued ID", "typeName": "governmentId", "description": "elided.", "reviewedBy": "/users/users/0399abed-fd3d-4830-a88b-30f38b8a365c", "reviewedAt": "2018-04-17T10:12:58.375Z" } }, "prodState": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "pending", "active", "inactive", "removed" ], "default": "pending" }, "addresses": { "title": "elided.", "description": "elided.", "properties": { "addresses": { "description": "elided.", "type": "array", "items": { "type": "object", "$ref": "#/definitions/address" } }, "preferredMailingAddressId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4 } }, "example": { "addresses": [ { "_id": "ha1", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US" }, { "_id": "wa1", "type": "work", "addressLine1": "123 S 3rd Street", "addressLine2": "Apt 42", "city": "Wilmington", "regionCode": "NC", "postalCode": "28411-5405", "countryCode": "US" } ], "preferredMailingAddressId": "ha1" } }, "emailAddresses": { "title": "elided.", "description": "elided.", "properties": { "emailAddresses": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/typedEmailAddress" } }, "preferredEmailAddressId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4 } }, "example": { "emailAddresses": [ { "id": "pe0", "value": "api@apiture.com", "type": "personal" }, { "id": "wp1", "value": "support@apiture.com", "type": "work" } ], "preferredEmailAddressId": "pe0" } }, "phoneNumbers": { "title": "elided.", "description": "elided.", "properties": { "phones": { "description": "elided.", "type": "array", "items": { "$ref": "#/definitions/phoneNumber" } }, "preferredPhoneId": { "description": "elided.", "type": "string", "minLength": 1, "maxLength": 4 } }, "example": { "phones": [ { "_id": "hp1", "type": "home", "number": "(555) 555-5555" }, { "_id": "mp1", "type": "mobile", "number": "(999) 555-5555" } ], "preferredPhoneId": "hp1" } }, "roleFields": { "title": "elided.", "description": "elided.", "properties": { "name": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1, "example": "primaryUser" }, "label": { "description": "elided.", "type": "string", "maxLength": 128, "minLength": 1, "example": "Primary User" }, "description": "elided." }, "example": { "name": "primaryUser", "label": "Primary User", "description": "elided." } }, "estimatedAnnualRevenue": { "title": "elided.", "x-apiuture-fragment": true, "description": "elided.", "type": "string", "enum": [ "unknown", "under1Million", "from1to10Million", "from10to100Million", "over100Million", "other", "notApplicable" ] }, "intermediaryServices": { "title": "elided.", "x-apiuture-fragment": true, "description": "elided.", "type": "string", "enum": [ "unknown", "accounting", "fundsManagement", "insurance", "investment", "legal", "medical", "notary", "realEstate", "taxPreparation", "trustManagement", "gambling", "securities", "loanFinance", "pawnBrokerage", "travelAgency", "vehicleSales", "foreignCurrency", "preciousMetals", "other", "notApplicable" ] }, "regulatoryValue": { "title": "elided.", "description": "elided." }, "organizationType": { "title": "elided.", "description": "elided.", "type": "string" }, "organizationSubtype": { "title": "elided.", "description": "elided.", "type": "string" }, "organizationIdentification": { "title": "elided.", "description": "elided.", "type": "object", "required": [ "type", "value" ], "properties": { "value": { "description": "elided.", "type": "string" }, "type": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/organizationIdentificationType" } ] }, "expiresOn": { "description": "elided.", "type": "string", "format": "date" }, "expiration": { "description": "elided.", "type": "string", "format": "date" } } }, "organizationAddress": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/address" }, { "type": "object", "properties": { "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/profileItemState" } ] } } }, { "$ref": "#/definitions/abstractResource" } ], "example": { "_id": "ha1", "type": "home", "addressLine1": "555 N Front Street", "addressLine2": "Suite 5555", "city": "Wilmington", "regionCode": "NC", "postalCode": "28401-5405", "countryCode": "US", "state": "approved", "_links": { "self": { "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1" } } } }, "organizationPhoneNumber": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/phoneNumber" }, { "type": "object", "properties": { "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/profileItemState" } ] } } }, { "$ref": "#/definitions/abstractResource" } ], "example": { "_id": "hp1", "_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json", "type": "home", "number": "555-555-5555", "state": "approved", "_links": { "self": { "href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1" } } } }, "organizationEmailAddress": { "title": "elided.", "description": "elided.", "allOf": [ { "$ref": "#/definitions/typedEmailAddress" }, { "type": "object", "properties": { "state": { "description": "elided.", "allOf": [ { "$ref": "#/definitions/profileItemState" } ] } } }, { "$ref": "#/definitions/abstractResource" } ], "example": { "_id": "pe1", "_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json", "type": "personal", "number": "555-555-5555", "state": "approved", "_links": { "self": { "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1" }, "delete": { "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1" }, "apiture:setAsPreferred": { "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1" } } } }, "phoneNumberType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "home", "work", "mobile", "fax", "other" ] }, "citizenship": { "title": "elided.", "description": "elided.", "type": "array", "items": { "type": "object", "required": [ "countryCode", "state" ], "properties": { "countryCode": { "description": "elided.", "type": "string", "minLength": 2, "maxLength": 2 }, "state": { "description": "elided.", "type": "string", "enum": [ "citizen", "other" ] } } }, "example": [ { "countryCode": "US", "state": "citizen" } ] }, "residencyStatus": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "resident", "nonresident", "residentAlien", "nonresidentAlien", "other", "notApplicable" ] }, "occupation": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "architectureAndEngineering", "artsDesignEntertainmentSportsAndMedia", "buildingAndGroundsCleaningAndMaintenance", "businessAndFinancialOperations", "communityAndSocialService", "computerAndMathematical", "constructionAndExtraction", "educationTrainingAndLibrary", "farmingFishingAndForestry", "foodPreparationAndServingRelated", "healthcarePractitionersAndTechnical", "healthcareSupport", "installationMaintenanceAndRepair", "legal", "lifePhysicalAndSciences", "management", "militarySpecific", "officeAndAdministrativeSupport", "personalCareAndService", "production", "protectiveServices", "salesAndRelated", "transportationAndMaterialMoving", "other", "notApplicable" ] }, "yearsAtAddress": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "oneOrFewer", "two", "three", "fourOrMore" ] }, "emailType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "personal", "work", "school", "other", "notApplicable" ] }, "disallowedState": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "rejected", "waived", "returned", "canceled" ] }, "employmentStatus": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "fullTime", "partTime", "paidLeave", "retired", "unemployed", "other", "notApplicable" ] }, "foreignPoliticalFigureAssociation": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "closeAssociate", "familyMember", "none", "other", "notApplicable" ] }, "approvalState": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "open", "submitted", "approved", "rejected", "waived", "returned", "canceled" ], "default": "open" }, "addressType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "unknown", "home", "prior", "work", "school", "mailing", "vacation", "shipping", "billing", "headquarters", "commercial", "site", "property", "other", "notApplicable" ] }, "organizationIdentificationType": { "title": "elided.", "description": "elided.", "type": "string", "enum": [ "taxId", "dunsNumber" ] } } }