openapi: 3.0.0 servers: - url: 'https://api.devbank.apiture.com/partners' x-note: DO NOT EDIT THIS GENERATED FILE. Edit source file src/openapi/openapi.yaml x-note-generated-by: openapi-schema-resolver x-note-generated-on: '2020-10-23T12:47:23-0400' info: title: Partner Organizations description: 'Client and partner organizations (businesses, financial institutions etc.) which register on the Apiture Developer portal for API keys.' version: 0.13.2 contact: name: Apiture url: 'https://developer.apiture.com' email: api@apiture.com termsOfService: 'https://developer.apiture.com/docs/Apiture-Open-API-License-Agreement.pdf' tags: - name: Partner Organization description: Partner Organization - name: API description: Endpoints which describe this API. paths: /organizations: get: summary: Return a collection of organizations description: >- Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [filterable](https://developer.apiture.com/docs/concepts/filtering) collection of organizations. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. The result is limited to partner organizations that the caller has access to (usually, their own partner organization) based on their email address domain. (Admin users have access to all partner organizations.) operationId: getOrganizations security: - apiKey: [] accessToken: - profiles/read x-apiture-implemented: true tags: - Partner Organization parameters: - $ref: '#/components/parameters/startQueryParam' - name: limit in: query description: The maximum number of organization representations to return in this page. schema: type: integer format: int32 default: 100 - $ref: '#/components/parameters/filterQueryParam' - name: domain in: query description: >- Subset the result to match only partner organizations whose `domain` property matches this value. This is combined with the `filter` query, if any, via and implicit `and`. Note that for most users, the collection is already implicitly filtered to their organization. schema: type: string - $ref: '#/components/parameters/typeQueryParam' - $ref: '#/components/parameters/stateQueryParam' - $ref: '#/components/parameters/nameQueryParam' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/organizations' application/json: schema: $ref: '#/components/schemas/organizations' '400': $ref: '#/components/responses/400' '422': $ref: '#/components/responses/422' x-apiture-traits: sortBy: - state - type - name - domain itemSchema: organization filters: state: filter: - eq - ne - in type: filter: - eq - ne - in name: filter: - eq - ne - lt - le - gt - ge - startsWith - endsWith - contains - search domain: filter: - eq post: summary: Create a new organization description: Create a new organization in the organizations collection. operationId: createOrganization security: - apiKey: [] accessToken: - profiles/write x-apiture-implemented: true tags: - Partner Organization responses: '201': description: Created headers: Location: description: >- The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host` schema: type: string format: uri ETag: description: >- The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource. schema: type: string content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403Partner' '409': $ref: '#/components/responses/409OrganizationConflict' requestBody: content: application/hal+json: schema: $ref: '#/components/schemas/createOrganization' application/json: schema: $ref: '#/components/schemas/createOrganization' description: The data necessary to create a new organization. required: true '/organizations/{organizationId}': get: summary: Fetch a representation of this organization description: >- Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this organization resource. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.) operationId: getOrganization security: - apiKey: [] accessToken: - profiles/read x-apiture-implemented: true tags: - Partner Organization parameters: - $ref: '#/components/parameters/organizationIdPathParam' - $ref: '#/components/parameters/ifNoneMatchHeaderParam' responses: '200': description: OK headers: ETag: description: >- The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource. schema: type: string content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' '304': $ref: '#/components/responses/304' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404Organization' put: summary: Update this organization description: >- Perform a complete replacement of this organization. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.) operationId: updateOrganization security: - apiKey: [] accessToken: - profiles/write x-apiture-implemented: true tags: - Partner Organization parameters: - $ref: '#/components/parameters/organizationIdPathParam' - $ref: '#/components/parameters/ifMatchHeaderParam' responses: '200': description: OK headers: ETag: description: >- The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource. schema: type: string content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404Organization' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' requestBody: content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' required: true patch: summary: Update this organization description: >- Perform a partial update of this organization. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.) operationId: patchOrganization security: - apiKey: [] accessToken: - profiles/write x-apiture-implemented: true tags: - Partner Organization parameters: - $ref: '#/components/parameters/organizationIdPathParam' - $ref: '#/components/parameters/ifMatchHeaderParam' responses: '200': description: OK headers: ETag: description: >- The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource. schema: type: string content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' '400': $ref: '#/components/responses/400' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404Organization' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' requestBody: content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' required: true delete: summary: Delete this organization resource description: Delete this organization resource. Most callers do not have delete access. (Admin users have delete access to all partner organizations.) operationId: deleteOrganization security: - apiKey: [] accessToken: - admin/delete x-apiture-implemented: true tags: - Partner Organization parameters: - $ref: '#/components/parameters/ifMatchHeaderParam' - $ref: '#/components/parameters/organizationIdPathParam' responses: '204': $ref: '#/components/responses/204' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404Organization' '409': $ref: '#/components/responses/409PartnerConflict' '412': $ref: '#/components/responses/412' '/organizations/{organizationId}/memberInvitations': post: summary: Invite new members description: >- Invite new members to this partner organization. This operation sends the invitees an invitation email. This API does not track which people it has sent invitations to; it unconditionally emails each invitee even if they have been invited in the past or are already registered. When the recipients register on the developer portal with an email address with the same partner `domain`, they are automatically added to the organization. TODO: Provide API to remove members (i.e. if they leave the organization.) operationId: inviteMembers tags: - Partner Organization parameters: - $ref: '#/components/parameters/organizationIdPathParam' responses: '202': description: Accepted content: application/hal+json: schema: $ref: '#/components/schemas/invitation' application/json: schema: $ref: '#/components/schemas/invitation' '400': $ref: '#/components/responses/400' '422': description: Unprocessable Entity. There are errors in the request. x-apiture-errors: - wrongPartnerDomain content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' security: - apiKey: [] accessToken: - data/write requestBody: content: application/hal+json: schema: $ref: '#/components/schemas/createInvitation' application/json: schema: $ref: '#/components/schemas/createInvitation' description: The data necessary to invite one or more new members. required: true /: get: summary: Top-level resources and operations in this API description: Return links to the top-level resources and operations in this API. operationId: getApi security: - apiKey: [] x-apiture-implemented: true responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/root' application/json: schema: $ref: '#/components/schemas/root' tags: - API /apiDoc: get: summary: Return API definition document description: Return the OpenAPI document that describes this API. operationId: getApiDoc security: - apiKey: [] x-apiture-implemented: true responses: '200': description: OK content: application/json: schema: type: object application/openapi+json;version=2.0: schema: type: object application/openapi+yaml;version=2.0: schema: type: object application/hal+json: schema: type: object tags: - API /labels: get: summary: Localized Labels description: |- Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API. The labels in the response may not all match the requested language; some may be in the default language (`en-us`). operationId: getLabels security: - apiKey: [] x-apiture-implemented: true parameters: - name: Accept-Language in: header description: >- The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5). schema: type: string responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/localizedLabels' application/json: schema: $ref: '#/components/schemas/localizedLabels' tags: - API /activeOrganizations: post: summary: Activate a partner organization. tags: - Partner Organization description: >- Activate a partner organization from an inactive state.

This operation is invoked from the `apiture:activate` link on an organization resource when that partner resource is eligible to be activated.

This changes the `state` to `active`. operationId: activateOrganization security: - apiKey: [] accessToken: - profiles/write x-apiture-implemented: true parameters: - $ref: '#/components/parameters/organizationQueryParam' - $ref: '#/components/parameters/ifMatchHeaderParam' responses: '200': description: OK headers: ETag: description: >- The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this partner organization resource. schema: type: string content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' '400': $ref: '#/components/responses/400Organization' '409': $ref: '#/components/responses/409OrganizationConflict' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' /inactiveOrganizations: post: summary: Deactivate a partner organization. tags: - Partner Organization description: >- Deactivate a partner organization from an active state.

This operation is invoked from the `apiture:deactivate` link on an organization resource when that partner organization is eligible to be deactivated.

This changes the `state` to `inactive`. operationId: deactivateOrganization security: - apiKey: [] accessToken: - profiles/write x-apiture-implemented: true parameters: - $ref: '#/components/parameters/organizationQueryParam' - $ref: '#/components/parameters/ifMatchHeaderParam' responses: '200': description: OK headers: ETag: description: >- The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this partner organization resource. schema: type: string content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' '400': $ref: '#/components/responses/400Organization' '409': $ref: '#/components/responses/409OrganizationConflict' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' /removedOrganizations: post: summary: Remove a partner organization. tags: - Partner Organization description: >- Remove a partner organization by setting its state to `removed`.

This operation is invoked from the `apiture:remove` link on a organization resource when that resource is eligible to be removed. The organization must not be in use (there may not be any active associations to the organization).

This changes the `state` to `removed`. operationId: removeOrganization security: - apiKey: [] accessToken: - profiles/write x-apiture-implemented: true parameters: - $ref: '#/components/parameters/organizationQueryParam' - $ref: '#/components/parameters/ifMatchHeaderParam' responses: '200': description: OK headers: ETag: description: >- The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this partner organization resource. schema: type: string content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' '400': $ref: '#/components/responses/400Organization' '409': $ref: '#/components/responses/409OrganizationConflict' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' /domainValidations: get: summary: Validate a partner domain name description: >- Check if a partner domain is valid. Some domains are not valid for use in the developer portal, such as those assocated with generic email services (`gmail.com`, `outlook.com`, `yahoo.com`, `aol.com`, and so on). The domain is passed as a query parameter. The 200 response is a JSON object, and the `_error` will be populated if the domain is not valid. x-apiture-comments: - 'By design, this operation does not require an access token, just an API key.' operationId: validatePartnerDomain tags: - Partner Organization security: - apiKey: [] parameters: - name: domain in: query required: true description: >- A candidate partner domain, such as `example.com` or `apiture.com`. This is typically taked from the user's email address, following the `@` character. schema: type: string responses: '200': description: >- A HAL response, with an optional `_error` object. If the domain name is valid, there is no `_error` object in the response. If the domain is invalid, the `_error` object describes the error. x-apiture-errors: - invalidPartnerDomain content: application/hal+json: schema: $ref: '#/components/schemas/domainValidation' application/json: schema: $ref: '#/components/schemas/domainValidation' x-apiture-traits: - api: title: Partner Organizations basePath: partners links: - getApi - getApiDoc - getOrganizations - createOrganization - getLabels - resource: name: organization description: 'Information (mailing addresses, phone numbers, email addresses) for an partner organization (business, non-profit, trust).' sortable: false searchable: false cursor: true excludeMethods: - delete x-apiture-errors: wrongPartnerDomain: description: The invitee's email address does not match this partner's domain. remediation: Invite only people on the same partner domain. attributes: properties: expectedDomain: description: The expected partner domain type: string actualDomain: description: 'The actual, unmatched partner domain.' type: string organizationAccessForbidden: description: The credentials supplied in the request are insufficient to grant access remediation: Check the supplied credentials for validity malformedRequestBodyBadRequest: description: The supplied request body was malformed remediation: Check to make sure that your request body exists and that it does not contain syntax errors preconditionRequiredIfMatchHeader: description: The required if-match header was not supplied remediation: Send a valid if-match header invalidPartnerDomain: description: The current user's email address is associated with a restricted partner organization domain. remediation: 'Register using a company email address, not an email service.' partnerOrganizationInUse: description: The partner organization may be be deleted if there are client applications. remediation: 'First remove then delete all client applications belonging to this partner organization, then delete the partner organization.' removedPartnerOrganizationImmutable: description: The state of a removed partner organization may not be changed. remediation: Delete the partner organization and create a new one. components: schemas: organizationFields: title: Partner Organization Fields description: Common fields of the organization resource used to build other model schemas. example: name: Smith's Auto Detailing label: Smith's Detailing emailAddresses: - type: work value: smitties-detailing@example.com _id: we0 phones: - type: work number: (555) 555-5555 _id: wp0 - type: mobile number: (999) 555-5555 _id: mp0 addresses: - type: work addressLine1: 555 N Front Street addressLine2: Suite 5555 city: Wilmington regionCode: NC postalCode: 28401-5405 countryCode: US _id: wa0 - type: work addressLine1: 123 S 3rd Street addressLine2: Apt 42 city: Wilmington regionCode: NC postalCode: 28411-5405 countryCode: US _id: wa0 state: active establishedDate: {} x-apiture-composition: - $ref: '#/components/schemas/simpleOrganization' - properties: - state - homeUrl properties: name: description: The organization's official full name type: string label: description: The organization's common name. type: string type: description: |- Indicates what type of organization this resource represents. The enumeration values are described by the `organizationType` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationType' subtype: description: |- A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationSubtype' identification: description: A collection of official identifying information associated with the organization. This currently only supports government tax ID. type: array items: $ref: '#/components/schemas/organizationIdentification' addresses: description: An array containing address items. type: array items: $ref: '#/components/schemas/organizationAddress' phones: description: >- An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. type: array items: $ref: '#/components/schemas/organizationPhoneNumber' emailAddresses: description: 'An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.' type: array items: $ref: '#/components/schemas/organizationEmailAddress' preferredEmailAddressId: description: |- The ID of the organization's preferred email address. This string is the `_id` of an email address in the `emailAddresses` array. This value is set with the `setPreferredEmailAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredPhoneId: description: >- The ID of organization's preferred phone number. This string is the `_id` of a phone number in the `phones` array. This value is set with the `setPreferredPhoneNumber` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredMailingAddressId: description: >- The preferred mailing address. This string is the `_id` of an address in the `addresses` array. This value is set with the `setPreferredMailingAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true establishedDate: description: The date the organization was established. type: string format: date state: $ref: '#/components/schemas/organizationState' homeUrl: description: The organization's home page. type: string format: uri maxLength: 512 type: object x-apiture-flattened: true organizationState: title: Partner Organization State description: The state of this partner organization. type: string enum: - pending - inactive - active - removed x-apiture-enum: organizationState x-apiture-flattened: true createOrganization: title: Create Partner Organization description: Representation used to create a new organization. required: - name example: _profile: 'https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json' x-apiture-composition: - $ref: '#/components/schemas/abstractResource' - $ref: '#/components/schemas/organizationFields' - properties: - attributes properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' name: description: The organization's official full name type: string label: description: The organization's common name. type: string type: description: |- Indicates what type of organization this resource represents. The enumeration values are described by the `organizationType` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationType' subtype: description: |- A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationSubtype' identification: description: A collection of official identifying information associated with the organization. This currently only supports government tax ID. type: array items: $ref: '#/components/schemas/organizationIdentification' addresses: description: An array containing address items. type: array items: $ref: '#/components/schemas/organizationAddress' phones: description: >- An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. type: array items: $ref: '#/components/schemas/organizationPhoneNumber' emailAddresses: description: 'An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.' type: array items: $ref: '#/components/schemas/organizationEmailAddress' preferredEmailAddressId: description: |- The ID of the organization's preferred email address. This string is the `_id` of an email address in the `emailAddresses` array. This value is set with the `setPreferredEmailAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredPhoneId: description: >- The ID of organization's preferred phone number. This string is the `_id` of a phone number in the `phones` array. This value is set with the `setPreferredPhoneNumber` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredMailingAddressId: description: >- The preferred mailing address. This string is the `_id` of an address in the `addresses` array. This value is set with the `setPreferredMailingAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true establishedDate: description: The date the organization was established. type: string format: date state: $ref: '#/components/schemas/organizationState' homeUrl: description: The organization's home page. type: string format: uri maxLength: 512 attributes: type: object description: An optional map of name/value pairs which provide additional metadata about the organization. type: object x-apiture-flattened: true summaryOrganization: title: Partner Organization Summary description: >- Summary representation of a partner organization resource in organizations collections. This representation normally does not contain any `_embedded` objects. If needed, call the `GET` operation on the item's `self` link to get `_embedded` objects. 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 x-apiture-composition: - $ref: '#/components/schemas/abstractResource' - $ref: '#/components/schemas/organizationFields' - properties: - _id - properties: - domain properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' name: description: The organization's official full name type: string label: description: The organization's common name. type: string type: description: |- Indicates what type of organization this resource represents. The enumeration values are described by the `organizationType` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationType' subtype: description: |- A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationSubtype' identification: description: A collection of official identifying information associated with the organization. This currently only supports government tax ID. type: array items: $ref: '#/components/schemas/organizationIdentification' addresses: description: An array containing address items. type: array items: $ref: '#/components/schemas/organizationAddress' phones: description: >- An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. type: array items: $ref: '#/components/schemas/organizationPhoneNumber' emailAddresses: description: 'An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.' type: array items: $ref: '#/components/schemas/organizationEmailAddress' preferredEmailAddressId: description: |- The ID of the organization's preferred email address. This string is the `_id` of an email address in the `emailAddresses` array. This value is set with the `setPreferredEmailAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredPhoneId: description: >- The ID of organization's preferred phone number. This string is the `_id` of a phone number in the `phones` array. This value is set with the `setPreferredPhoneNumber` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredMailingAddressId: description: >- The preferred mailing address. This string is the `_id` of an address in the `addresses` array. This value is set with the `setPreferredMailingAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true establishedDate: description: The date the organization was established. type: string format: date state: $ref: '#/components/schemas/organizationState' homeUrl: description: The organization's home page. type: string format: uri maxLength: 512 domain: description: >- This partner organization's internet domain name. This is derived from the domain name of email address of the first user that registers with the organizations email domain. The dev portal adds other user's to the partner organization that matches their verified email address domain. type: string readOnly: true type: object x-apiture-flattened: true organization: title: Partner Organization description: >- Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for a partner organization. a partner organization may have the following links in the `_links` object: * **`apiture:activate`** - Activate a new, pending organization. * **`apiture:deactivate`** - Deactivate a partner organization (if it is active). * **`apiture:remove`** - Remove an inactive organization. example: _id: 0399abed-fd3d-4830-a88b-30f38b8a365c _profile: 'https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json' 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: {} x-apiture-composition: - $ref: '#/components/schemas/summaryOrganization' - properties: - attributes - createdAt - updatedAt properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' name: description: The organization's official full name type: string label: description: The organization's common name. type: string type: description: |- Indicates what type of organization this resource represents. The enumeration values are described by the `organizationType` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationType' subtype: description: |- A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationSubtype' identification: description: A collection of official identifying information associated with the organization. This currently only supports government tax ID. type: array items: $ref: '#/components/schemas/organizationIdentification' addresses: description: An array containing address items. type: array items: $ref: '#/components/schemas/organizationAddress' phones: description: >- An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. type: array items: $ref: '#/components/schemas/organizationPhoneNumber' emailAddresses: description: 'An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.' type: array items: $ref: '#/components/schemas/organizationEmailAddress' preferredEmailAddressId: description: |- The ID of the organization's preferred email address. This string is the `_id` of an email address in the `emailAddresses` array. This value is set with the `setPreferredEmailAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredPhoneId: description: >- The ID of organization's preferred phone number. This string is the `_id` of a phone number in the `phones` array. This value is set with the `setPreferredPhoneNumber` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredMailingAddressId: description: >- The preferred mailing address. This string is the `_id` of an address in the `addresses` array. This value is set with the `setPreferredMailingAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true establishedDate: description: The date the organization was established. type: string format: date state: $ref: '#/components/schemas/organizationState' homeUrl: description: The organization's home page. type: string format: uri maxLength: 512 domain: description: >- This partner organization's internet domain name. This is derived from the domain name of email address of the first user that registers with the organizations email domain. The dev portal adds other user's to the partner organization that matches their verified email address domain. type: string readOnly: true attributes: type: object description: An optional map of name/value pairs which provide additional metadata about the organization. createdAt: description: The date-time when the organization was created. type: string format: date-time updatedAt: description: The date-time when the organization was updated type: string format: date-time type: object x-apiture-flattened: true organizations: title: Partner Organization Collection description: |- Collection of organizations. The items in the collection are ordered in the `_embedded.items` array; the `name` is `organizations`. The top-level `_links` object may contain pagination links (`self`, `next`, `prev`, `first`, `last`, `collection`). example: start: g434ljkf430 limit: 10 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: /organizations/organizations?start=g434ljkf430&limit=10 next: href: /organizations/organizations?start=p4900sk3df9&limit=10 collection: href: /organizations/organizations count: 10 name: organizations _embedded: items: anyOf: - _id: 331af113-8f7b-422d-89fe-d0489cc43e5d _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/331af113-8f7b-422d-89fe-d0489cc43e5d' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b-422d-89fe-d0489cc43e5d' name: Apiture label: '' type: trust state: pending - _id: a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7' name: Apiture label: '' type: nonprofit state: pending - _id: 0c748e89-3180-4d43-927d-5120d39b4fa8 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/0c748e89-3180-4d43-927d-5120d39b4fa8' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=0c748e89-3180-4d43-927d-5120d39b4fa8' name: Apiture label: '' type: nonprofit state: pending - _id: fb602721-ac57-4d68-835d-f649e351e2b5 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/fb602721-ac57-4d68-835d-f649e351e2b5' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=fb602721-ac57-4d68-835d-f649e351e2b5' name: Apiture label: '' type: nonprofit state: pending - _id: 64b636ec-cebe-44bc-9962-d4de2329abe3 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/64b636ec-cebe-44bc-9962-d4de2329abe3' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=64b636ec-cebe-44bc-9962-d4de2329abe3' name: Apiture label: '' type: municipality state: pending - _id: c161edaa-293f-4c01-a232-e9a14344b297 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/c161edaa-293f-4c01-a232-e9a14344b297' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=c161edaa-293f-4c01-a232-e9a14344b297' name: Apiture label: '' type: nonprofit state: pending - _id: 2b094e5d-d2a7-4a03-8110-64ac9ac457e6 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/2b094e5d-d2a7-4a03-8110-64ac9ac457e6' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=2b094e5d-d2a7-4a03-8110-64ac9ac457e6' name: example corporation label: '' type: corporation state: pending - _id: ccaea92d-5ba0-4f30-a39f-a422ad02e7ad _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/ccaea92d-5ba0-4f30-a39f-a422ad02e7ad' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=ccaea92d-5ba0-4f30-a39f-a422ad02e7ad' name: example llc label: '' type: llc state: pending - _id: 43f53a1f-7d00-443b-87ee-04f0704ffb14 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/43f53a1f-7d00-443b-87ee-04f0704ffb14' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=43f53a1f-7d00-443b-87ee-04f0704ffb14' name: example partnership label: '' type: partnership state: pending - _id: 741fee0e-7f94-4d30-9fd7-62a318768d23 _profile: 'https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json' _links: self: href: 'https://api.apiture.com/organizations/organizations/741fee0e-7f94-4d30-9fd7-62a318768d23' 'apiture:activate': href: 'https://api.apiture.com/organizations/activeOrganizations?organization=741fee0e-7f94-4d30-9fd7-62a318768d23' name: example llp label: '' type: llp state: pending x-apiture-composition: - $ref: '#/components/schemas/cursorPagedCollection' - properties: - _embedded properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: type: object description: Embedded objects. properties: items: description: An array containing a page of organization items. type: array items: $ref: '#/components/schemas/summaryOrganization' _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' start: description: >- An opaque marker representing the position of the current page in this resource collection. The service will use the `start` and `limit` to compute the `?start=` query parameter for the next page when it provides the `next` link in the collection's `_links`. type: string limit: description: The maximum number of items per page. type: integer name: description: A name for the items in collection. type: string type: object x-apiture-flattened: true domainValidation: title: Domain Validation description: The response from validating a partner domain. x-apiture-composition: - $ref: '#/components/schemas/abstractResource' - properties: - valid properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' valid: type: boolean description: '`true` if the domain is valid, `false` if not. If `false`, consult the `_error` object.' type: object x-apiture-flattened: true createInvitation: title: Create Invitation description: Representation used to create an invitation to join a partner organization. required: - message - invitees example: _profile: 'https://api.apiture.com/schemas/partnerOrganizations/createInvitation/v1.0.0/profile.json' message: I am inviting you to join our partner organization on the Apiture Developer Portal. invitees: - firstName: John lastName: Smith emailAddress: john.smith@example.com x-apiture-composition: - $ref: '#/components/schemas/abstractRequest' - $ref: '#/components/schemas/invitationFields' properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri message: description: An invitation message from the inviter to includ in the invitation email. The message is Markdown which can be formatted with rich text. type: string format: markdown minLength: 16 maxLength: 512 invitees: description: The list of invitees. type: array minItems: 1 maxItems: 16 items: $ref: '#/components/schemas/invitee' type: object x-apiture-flattened: true invitation: title: Member Invitation description: Partner Organization member invitation. required: - message - invitees example: _profile: 'https://api.apiture.com/schemas/partnerOrganizations/invitation/v1.0.0/profile.json' message: I am inviting you to join our partner organization on the Apiture Developer Portal. invitees: - firstName: John lastName: Smith emailAddress: john.smith@example.com x-apiture-composition: - $ref: '#/components/schemas/abstractResource' - $ref: '#/components/schemas/invitationFields' properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' message: description: An invitation message from the inviter to includ in the invitation email. The message is Markdown which can be formatted with rich text. type: string format: markdown minLength: 16 maxLength: 512 invitees: description: The list of invitees. type: array minItems: 1 maxItems: 16 items: $ref: '#/components/schemas/invitee' type: object x-apiture-flattened: true invitationFields: title: Invitation fields description: 'Fields of a member invitation. This is fragment schema, used to construct other schemas' x-apiture-fragment: true type: object properties: message: description: An invitation message from the inviter to includ in the invitation email. The message is Markdown which can be formatted with rich text. type: string format: markdown minLength: 16 maxLength: 512 invitees: description: The list of invitees. type: array minItems: 1 maxItems: 16 items: $ref: '#/components/schemas/invitee' example: message: I am inviting you to joint our partner organization on the Apiture Developer Portal. invitees: - firstName: John lastName: Smith emailAddress: john.smith@example.com x-apiture-flattened: true invitee: title: Invitee description: Representation of new partner organization member invitee. required: - firstName - lastName - emailAddress type: object properties: firstName: description: The first name of the invitee. type: string maxLength: 64 lastName: description: The last name of the invitee. type: string maxLength: 64 emailAddress: description: The email address of the invitee. type: string maxLength: 128 example: firstName: John lastName: Smith emailAddress: john.smith@example.com x-apiture-flattened: true errorResponse: x-apiture-version: 2.0.0 title: Error Response (v2.0.0) description: 'Describes an error response, typically returned on 4xx or 5xx errors from API operations. The `_error` object contains the error details.' 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: [] x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/errorResponse/v2.0.0/model.json' x-apiture-namespace: common x-apiture-composition: - $ref: '#/components/schemas/abstractResource' properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' type: object x-apiture-flattened: true root: x-apiture-version: 2.0.0 title: API Root (v2.0.0) description: 'A HAL response, with hypermedia `_links` for the top-level resources and operations in API.' 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: {} x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/root/v2.0.0/model.json' x-apiture-namespace: common x-apiture-composition: - $ref: '#/components/schemas/abstractResource' - properties: - _id - name - apiVersion properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' _id: description: This API's unique ID. readOnly: true type: string name: type: string description: This API's name. apiVersion: type: string description: This API's version. type: object x-apiture-flattened: true localizedLabels: title: Localized Labels (v1.0.0) description: >- A map that defines lables for an enumeration or other item in a JSON schema. This is a map which maps enumeration schema names to an `localizedLabel` object. This schema is deprecated. Use [`labelGroups`](#schema-labelgroups)` instead. x-apiture-version: 1.0.0 x-apiture-deprecated: since: 1.0.0 replacement: labelGroups additionalProperties: $ref: '#/components/schemas/localizedLabel' x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/localizedLabels/v1.0.0/model.json' x-apiture-namespace: common type: object properties: {} x-apiture-flattened: true simpleOrganization: title: Simple Organization description: The simplest form of an organization. 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 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/simpleOrganization/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-version: 1.0.0 x-apiture-composition: - properties: - name - label - type - subtype - identification - addresses - phones - emailAddresses - preferredEmailAddressId - preferredPhoneId - preferredMailingAddressId - establishedDate properties: name: description: The organization's official full name type: string label: description: The organization's common name. type: string type: description: |- Indicates what type of organization this resource represents. The enumeration values are described by the `organizationType` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationType' subtype: description: |- A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation. allOf: - $ref: '#/components/schemas/organizationSubtype' identification: description: A collection of official identifying information associated with the organization. This currently only supports government tax ID. type: array items: $ref: '#/components/schemas/organizationIdentification' addresses: description: An array containing address items. type: array items: $ref: '#/components/schemas/organizationAddress' phones: description: >- An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. type: array items: $ref: '#/components/schemas/organizationPhoneNumber' emailAddresses: description: 'An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.' type: array items: $ref: '#/components/schemas/organizationEmailAddress' preferredEmailAddressId: description: |- The ID of the organization's preferred email address. This string is the `_id` of an email address in the `emailAddresses` array. This value is set with the `setPreferredEmailAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredPhoneId: description: >- The ID of organization's preferred phone number. This string is the `_id` of a phone number in the `phones` array. This value is set with the `setPreferredPhoneNumber` operation. type: string minLength: 1 maxLength: 4 readOnly: true preferredMailingAddressId: description: >- The preferred mailing address. This string is the `_id` of an address in the `addresses` array. This value is set with the `setPreferredMailingAddress` operation. type: string minLength: 1 maxLength: 4 readOnly: true establishedDate: description: The date the organization was established. type: string format: date type: object x-apiture-flattened: true abstractResource: x-apiture-version: 2.0.0 title: Abstract Resource (v2.0.0) description: >- An abstract schema used to define other schemas for request and response bodies. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation. This model contains hypermedia `_links`, and either optional domain object data with `_profile` and optional `_embedded` objects, or an `_error` object. In responses, if the operation was successful, this object will not include the `_error`, but if the operation was a 4xx or 5xx error, this object will not include `_embedded` or any data fields, only `_error` and optionally `_links`. example: _profile: 'https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json' _links: self: href: 'https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f' x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/model.json' x-apiture-namespace: common x-apiture-composition: - $ref: '#/components/schemas/abstractRequest' - properties: - _error properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' type: object x-apiture-flattened: true cursorPagedCollection: x-apiture-version: 2.0.0 title: Cursor Paged Collection (v2.0.0) description: >- A collection of resources, or a page from a larger collection. This is an abstract model schema which is extended to define specific resource collections. Pages are referenced using an opaque string starting point named `start`. The `_links` in the collection may contain [pagination links](https://developer.apiture.com/docs/concepts/pagination): * the `next` link returns the next page of items. If there is no `next` link, the collection has been exhausted. * the `first` link returns to the beginning of the filtered/sorted collection. * the `collection` link returns to the beginning of the default collection with no explicit filter or sort criteria. Cursor paged collections can only paginate forwards contiguously (without skipping items or pages), or reset to the beginning of the collection. This pagination works for collections which are likely to change during pagination, such as adding data to the beginning of the collection's natural sort order. Examples include transactions or audit records. x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/cursorPagedCollection/v2.0.0/model.json' x-apiture-namespace: common x-apiture-composition: - $ref: '#/components/schemas/abstractResource' - properties: - start - limit - name properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' start: description: >- An opaque marker representing the position of the current page in this resource collection. The service will use the `start` and `limit` to compute the `?start=` query parameter for the next page when it provides the `next` link in the collection's `_links`. type: string limit: description: The maximum number of items per page. type: integer name: description: A name for the items in collection. type: string type: object x-apiture-flattened: true abstractRequest: x-apiture-version: 2.0.0 title: Abstract Request (v2.0.0) description: >- An abstract schema used to define other request-only schemas. This is a [HAL](https://tools.ietf.org/html/draft-kelly-json-hal-08) resource representation, minus the `_error` defined in `abstractResource`. properties: _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri example: _profile: 'https://api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json' _links: self: href: 'https://api.devbank.apiture.com/applications/' x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/model.json' x-apiture-namespace: common type: object x-apiture-flattened: true error: x-apiture-version: 2.0.0 title: Error (v2.0.0) description: Describes an error in an API request or in a service called via the API. required: - message properties: message: type: string description: A localized message string describing the error condition. _id: description: >- A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string. readOnly: true type: string statusCode: description: The HTTP status code associate with this error. type: integer minimum: 100 maximum: 599 example: 422 type: type: string description: >- An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the `statusCode`. For example, instead of just 400 Bad Request, the `type` may be much more specific. such as `integerValueNotInAllowedRange` or `numericValueExceedsMaximum` or `stringValueNotInAllowedSet`. occurredAt: type: string format: date-time description: 'An [RFC 3339](https://tools.ietf.org/html/rfc3339) UTC time stamp indicating when the error occurred.' example: '2018-02-02T03:37:15.375Z' attributes: description: >- Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the `minimum` and `maximum` values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error `type`. allOf: - $ref: '#/components/schemas/attributes' remediation: type: string description: An optional localized string which provides hints for how the user or client can resolve the error. errors: description: An optional array of nested error objects. This property is not always present. type: array items: $ref: '#/components/schemas/error' _links: $ref: '#/components/schemas/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' x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/error/v2.0.0/model.json' x-apiture-namespace: common type: object x-apiture-flattened: true localizedLabel: title: Localized Label (v1.0.0) description: >- A localized label and optional description for localizable content defined in this API. This schema is deprecated; use [`labelItem`](#schema-labelitem) instead. x-apiture-version: 1.0.0 x-apiture-deprecated: since: 1.0.0 replacement: labelGroups type: object properties: label: type: string description: A localized label or title which may be used labels or other UI controls which present a value. example: Limited Liability Corporation description: type: string description: A more detailed localized description of a localizable label. language: type: string description: >- The actual natural language tag to which this localized label is associated, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-3.1.3.1) example: en-us code: type: string description: 'If the localized value is associated with an external standard, this is a lookup code or key or URI for that value.' example: '31' x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/localizedLabel/v1.0.0/model.json' x-apiture-namespace: common x-apiture-flattened: true links: title: Links (v1.0.0) x-apiture-version: 1.0.0 description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' type: object x-apiture-key: linkRelationName additionalProperties: $ref: '#/components/schemas/link' x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/links/v1.0.0/model.json' x-apiture-namespace: common properties: {} x-apiture-flattened: true organizationType: title: Organization Type (v1.0.0) description: |- The primary organization type. The allowed values for this property are defined at runtime in the [label group](https://developer.apiture.com/concepts/label-groups) named `organizationType` in the response from the [`getLabels`](#op-getLabels) operation. type: string x-apiture-choice: organizationType x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/organizationType/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-flattened: true organizationSubtype: title: Organization Subtype (v1.0.0) description: |- A refinement of the organization type. The allowed values for this property are defined at runtime in the [label group](https://developer.apiture.com/concepts/label-groups) named `organizationSubtype` in the response from the [`getLabels`](#op-getLabels) operation. type: string x-apiture-choice: organizationSubtype x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/organizationSubtype/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-flattened: true organizationIdentification: title: Organization Identification description: The type and value of the organizations unique identification numbers. type: object required: - type - value properties: value: description: 'The value of this form of identification (the tax ID as a string, for example)' type: string type: description: The type of this form of identification. `taxId` is the only supported type at this time. allOf: - $ref: '#/components/schemas/organizationIdentificationType' expiresOn: description: The date when this form of identification expires. type: string format: date expiration: description: The date when this form of identification expires. **Note** This property is deprecated; use `expiresOn`. type: string format: date x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/organizationIdentification/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-version: 1.0.0 x-apiture-flattened: true organizationAddress: title: Organization Address (v1.0.0) description: > Representation of an organization's address resource.

Response and request bodies using this organizationAddress schema may contain the following links:
RelSummaryMethod
deleteDelete this address resourceDELETE
apiture:setAsPreferredSet Preferred mailing AddressPUT
x-apiture-links: - rel: delete operationId: deleteAddress - rel: 'apiture:setAsPreferred' operationId: setPreferredAddress 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 x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-composition: - $ref: '#/components/schemas/address' - properties: - state - $ref: '#/components/schemas/abstractResource' properties: addressLine1: description: 'The first street address line of the address, normally a house number and street name.' type: string minLength: 4 maxLength: 128 addressLine2: description: The optional second street address line of the address. type: string maxLength: 128 city: description: The name of the city or municipality. type: string minLength: 2 maxLength: 128 regionCode: description: 'The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.' type: string example: NC minLength: 2 maxLength: 2 pattern: '^[a-zA-Z]{2}$' postalCode: description: 'The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.' type: string example: 28401-5405 minLength: 5 maxLength: 10 pattern: '^[0-9]{5}(?:-[0-9]{4})?$' countryCode: description: 'The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This is normalized to uppercase.' type: string minLength: 2 maxLength: 2 pattern: '^[a-zA-Z]{2}$' type: description: The type of this address. allOf: - $ref: '#/components/schemas/addressType' label: description: 'A text label, suitable for presentation to the end user. This is derived from `type` or from `otherType` if `type` is `other`' type: string readOnly: true minLength: 4 maxLength: 32 otherType: description: The actual address type if `type` is `other`. minLength: 4 maxLength: 32 type: string _id: description: >- An identifier for this address, so that it can be referenced uniquely. The service will assign a unique `_id` if the client does not provide one. The `_id` must be unique across all addresses within the `addresses` array. type: string minLength: 1 maxLength: 8 example: ha5 pattern: '^[-a-zA-Z0-9_]{1,8}$' _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' state: description: >- The state of this address. `pending` addresses require financial institution approval. Only `approved` addresses may be set as the preferred address. allOf: - $ref: '#/components/schemas/profileItemState' type: object x-apiture-flattened: true organizationPhoneNumber: title: Phone Number description: Representation of phone number resources. x-apiture-links: - rel: delete operationId: deletePhoneNumber - rel: 'apiture:setAsPreferred' operationId: setPreferredPhoneNumber 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 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-version: 1.0.0 x-apiture-composition: - $ref: '#/components/schemas/phoneNumber' - properties: - state - $ref: '#/components/schemas/abstractResource' properties: type: description: The type or role of this phone number. allOf: - $ref: '#/components/schemas/phoneNumberType' number: description: >- The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is `+1`. Phone numbers are returned in responses in [E.164](https://en.wikipedia.org/wiki/E.164) format with a leading `+`, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See [Phone Number Representations](https://developer.apiture.com/docs/concepts/phone-numbers/) for more information. type: string example: '+19105550155' minLength: 8 maxLength: 20 label: description: 'A text label, suitable for presentation to the end user. This is also used if `type` is `other`.' type: string example: assistant maxLength: 32 _id: description: >- An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique `_id` if the client does not provide one. The `_id` must be unique across all phone numbers within the `phones` array. type: string minLength: 1 maxLength: 8 example: ha5 pattern: '^[-a-zA-Z0-9_]{1,8}$' _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' state: description: >- The state of this phone number. `pending` numbers require financial institution approval. Only `approved` numbers may be set as the preferred phone number. allOf: - $ref: '#/components/schemas/profileItemState' type: object x-apiture-flattened: true organizationEmailAddress: title: Email Address (v1.0.0) description: > Representation of email address resources. An email address is immutable, although organizations can add new email addresses. Response and request bodies using this organizationEmailAddress schema may contain the following links:
RelSummaryMethod
deleteDelete this email address resourceDELETE
apiture:setAsPreferredSet Preferred Email AddressPUT
x-apiture-links: - rel: delete operationId: deleteEmailAddress - rel: 'apiture:setAsPreferred' operationId: setPreferredEmailAddress example: _id: pe1 _profile: 'https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json' type: personal number: '+19105550155' 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 x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-composition: - $ref: '#/components/schemas/typedEmailAddress' - properties: - state - $ref: '#/components/schemas/abstractResource' properties: value: description: 'The email address, such as `JohnBankCustomer@example.com`' type: string format: email minLength: 8 maxLength: 120 example: JohnBankCustomer@example.com type: description: The kind of email address. allOf: - $ref: '#/components/schemas/emailType' _id: description: >- An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique `_id` if the client does not provide one. The `_id` must be unique across all email addresses within the `emailAddresses` array. type: string minLength: 1 maxLength: 8 example: ha3 pattern: '^[-a-zA-Z0-9_]{1,8}$' _links: description: 'An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations.' allOf: - $ref: '#/components/schemas/links' _embedded: description: 'An optional map of nested resources, mapping each nested resource name to a nested resource representation.' type: object _profile: description: 'The URI of a [resource profile](https://developer.apiture.com/docs/concepts/profiles/) which describes the representation.' type: string format: uri _error: description: An object which describes an error. This value is omitted if the operation succeeded without error. type: object allOf: - $ref: '#/components/schemas/error' state: description: >- The state of this email address. `pending` email addresses require financial institution approval. Only `approved` numbers may be set as the preferred email address. allOf: - $ref: '#/components/schemas/profileItemState' type: object x-apiture-flattened: true link: x-apiture-version: 1.0.0 title: Link (v1.0.0) description: >- Describes a hypermedia link within a `_links` object in HAL representations. In Apiture APIs, links are [HAL links](https://developer.apiture.com/docs/concepts/links), but Apiture APIs do not use the `name` or `hreflang` properties of HAL. Apiture links _may_ include a `method` property. required: - href properties: href: type: string format: uri description: The URI or URI template for the resource/operation this link refers to. type: type: string description: The media type for the resource. templated: type: boolean description: 'If true, the link''s href is a [URI template](https://tools.ietf.org/html/rfc6570).' title: type: string description: An optional human-readable localized title for the link. deprecation: type: string format: uri description: 'If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation.' profile: type: string format: uri description: 'The URI of a profile document, a JSON document which describes the target resource/operation.' example: href: 'https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f' title: Application x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/link/v1.0.0/model.json' x-apiture-namespace: common type: object x-apiture-flattened: true typedEmailAddress: title: Email Address (v1.0.0) description: An email address and the email address type. properties: value: description: 'The email address, such as `JohnBankCustomer@example.com`' type: string format: email minLength: 8 maxLength: 120 example: JohnBankCustomer@example.com type: description: The kind of email address. allOf: - $ref: '#/components/schemas/emailType' _id: description: >- An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique `_id` if the client does not provide one. The `_id` must be unique across all email addresses within the `emailAddresses` array. type: string minLength: 1 maxLength: 8 example: ha3 pattern: '^[-a-zA-Z0-9_]{1,8}$' x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/contacts/typedEmailAddress/v1.0.0/model.json' x-apiture-namespace: contacts type: object x-apiture-flattened: true profileItemState: title: Organization Profile Item State (v1.0.0) description: >- The state of an item (address, email address, or phone number) within the organization's profile. New addresses, email addresses, or phone numbers start with the state `pending`, which means approval by the financial institution is pending. After they have been verified, the state becomes `approved`. Some normalizing or sanitizing of the value may occur when this happens (for example, a ZIP code may change to ZIP+4 format). `pending` items may not be assigned as the preferred item. profileItemState strings may have one of the following [enumerated values](https://developer.apiture.com/concepts/label-groups#enumerations):
ValueDescription
pendingPending: A profile item that the financial institution has not yet approved.
approvedApproved: A profile item that the financial institution has approved.
These enumeration values are further described by the [label group](https://developer.apiture.com/concepts/label-groups) named `profileItemState` in the response from the [`getLabels`](#op-getLabels) operation. type: string enum: - pending - approved example: approved x-apiture-enum: profileItemState x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/profileItemState/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-flattened: true attributes: x-apiture-version: 2.0.0 title: Attributes (v2.0.0) description: An optional map of name/value pairs which contains additional dynamic data about the resource. type: object x-apiture-key: attributeName additionalProperties: $ref: '#/components/schemas/attributeValue' x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/attributes/v2.0.0/model.json' x-apiture-namespace: common properties: {} x-apiture-flattened: true organizationIdentificationType: title: Organization Identification Type (v1.0.0) description: |- The type of the form of an organization's identification. `taxId` is the only supported type at this time. organizationIdentificationType strings may have one of the following [enumerated values](https://developer.apiture.com/concepts/label-groups#enumerations):
ValueDescription
taxIdTax Identification Number: The company's federal Tax Identification Number. This is also known as the Employer Identification Number or EIN in the US. It may be the owner's SSN for a sole proprietorship.
dunsNumberDun & Bradstreet D-U-N-S Number: Dun & Bradstreet D-U-N-S Number, a unique nine-digit identifier for businesses.
These enumeration values are further described by the [label group](https://developer.apiture.com/concepts/label-groups) named `organizationIdentificationType` in the response from the [`getLabels`](#op-getLabels) operation. type: string enum: - taxId - dunsNumber x-apiture-enum: organizationIdentificationType x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/organizations/organizationIdentificationType/v1.0.0/model.json' x-apiture-namespace: organizations x-apiture-flattened: true address: title: Address (v1.0.0) description: A postal address with the address type and an identifier. type: object required: - type example: _id: ha5 type: home addressLine1: 555 N Front Street addressLine2: Suite 5555 city: Wilmington regionCode: NC postalCode: 28401-5405 countryCode: US x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/contacts/address/v1.0.0/model.json' x-apiture-namespace: contacts x-apiture-composition: - $ref: '#/components/schemas/simpleAddress' - properties: - type - label - otherType - _id properties: addressLine1: description: 'The first street address line of the address, normally a house number and street name.' type: string minLength: 4 maxLength: 128 addressLine2: description: The optional second street address line of the address. type: string maxLength: 128 city: description: The name of the city or municipality. type: string minLength: 2 maxLength: 128 regionCode: description: 'The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.' type: string example: NC minLength: 2 maxLength: 2 pattern: '^[a-zA-Z]{2}$' postalCode: description: 'The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.' type: string example: 28401-5405 minLength: 5 maxLength: 10 pattern: '^[0-9]{5}(?:-[0-9]{4})?$' countryCode: description: 'The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This is normalized to uppercase.' type: string minLength: 2 maxLength: 2 pattern: '^[a-zA-Z]{2}$' type: description: The type of this address. allOf: - $ref: '#/components/schemas/addressType' label: description: 'A text label, suitable for presentation to the end user. This is derived from `type` or from `otherType` if `type` is `other`' type: string readOnly: true minLength: 4 maxLength: 32 otherType: description: The actual address type if `type` is `other`. minLength: 4 maxLength: 32 type: string _id: description: >- An identifier for this address, so that it can be referenced uniquely. The service will assign a unique `_id` if the client does not provide one. The `_id` must be unique across all addresses within the `addresses` array. type: string minLength: 1 maxLength: 8 example: ha5 pattern: '^[-a-zA-Z0-9_]{1,8}$' x-apiture-flattened: true phoneNumber: title: Phone Number (v1.0.0) description: A phone number and its role. type: object required: - type - number properties: type: description: The type or role of this phone number. allOf: - $ref: '#/components/schemas/phoneNumberType' number: description: >- The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is `+1`. Phone numbers are returned in responses in [E.164](https://en.wikipedia.org/wiki/E.164) format with a leading `+`, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See [Phone Number Representations](https://developer.apiture.com/docs/concepts/phone-numbers/) for more information. type: string example: '+19105550155' minLength: 8 maxLength: 20 label: description: 'A text label, suitable for presentation to the end user. This is also used if `type` is `other`.' type: string example: assistant maxLength: 32 _id: description: >- An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique `_id` if the client does not provide one. The `_id` must be unique across all phone numbers within the `phones` array. type: string minLength: 1 maxLength: 8 example: ha5 pattern: '^[-a-zA-Z0-9_]{1,8}$' example: _id: hp1 type: home number: '+19105550155' x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/contacts/phoneNumber/v1.0.0/model.json' x-apiture-namespace: contacts x-apiture-flattened: true emailType: title: Email Type (v1.0.0) description: |- The kind of email address. **Warning**: The `enum` list will be removed in a future release. The allowed values for this property are defined at runtime in the [label group](https://developer.apiture.com/concepts/label-groups) named `emailType` in the response from the [`getLabels`](#op-getLabels) operation. type: string x-apiture-choice: emailType enum: - unknown - personal - work - school - other - notApplicable x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/contacts/emailType/v1.0.0/model.json' x-apiture-namespace: contacts x-apiture-flattened: true phoneNumberType: title: Phone Number Type (v1.0.0) description: |- The type or role of this phone number. **Warning**: The `enum` list will be removed in a future release. The allowed values for this property are defined at runtime in the [label group](https://developer.apiture.com/concepts/label-groups) named `phoneNumberType` in the response from the [`getLabels`](#op-getLabels) operation. type: string x-apiture-choice: phoneNumberType enum: - unknown - home - work - mobile - fax - other x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/contacts/phoneNumberType/v1.0.0/model.json' x-apiture-namespace: contacts x-apiture-flattened: true simpleAddress: title: Simple Address (v1.0.0) description: A postal address. type: object properties: addressLine1: description: 'The first street address line of the address, normally a house number and street name.' type: string minLength: 4 maxLength: 128 addressLine2: description: The optional second street address line of the address. type: string maxLength: 128 city: description: The name of the city or municipality. type: string minLength: 2 maxLength: 128 regionCode: description: 'The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.' type: string example: NC minLength: 2 maxLength: 2 pattern: '^[a-zA-Z]{2}$' postalCode: description: 'The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.' type: string example: 28401-5405 minLength: 5 maxLength: 10 pattern: '^[0-9]{5}(?:-[0-9]{4})?$' countryCode: description: 'The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This is normalized to uppercase.' type: string minLength: 2 maxLength: 2 pattern: '^[a-zA-Z]{2}$' example: addressLine1: 555 N Front Street addressLine2: Suite 5555 city: Wilmington regionCode: NC postalCode: 28401-5405 countryCode: US x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/contacts/simpleAddress/v1.0.0/model.json' x-apiture-namespace: contacts x-apiture-flattened: true addressType: title: Address Type (v1.0.0) description: |- The type of a postal address. **Warning**: The `enum` list will be removed in a future release. The allowed values for this property are defined at runtime in the [label group](https://developer.apiture.com/concepts/label-groups) named `addressType` in the response from the [`getLabels`](#op-getLabels) operation. type: string x-apiture-choice: addressType enum: - unknown - home - prior - work - school - mailing - vacation - shipping - billing - headquarters - commercial - site - property - other - notApplicable x-apiture-version: 1.0.0 x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/contacts/addressType/v1.0.0/model.json' x-apiture-namespace: contacts x-apiture-flattened: true attributeValue: x-apiture-version: 2.0.0 title: Attribute Value (v2.0.0) description: The data associated with this attribute. x-apiture-resolved-from: 'https://production.api.apiture.com/schemas/common/attributeValue/v2.0.0/model.json' x-apiture-namespace: common type: object properties: {} x-apiture-flattened: true responses: '204': description: No Content. The resource was deleted successfully. '304': description: Not Modified. The resource has not been modified since it was last fetched. '400': description: >- Bad Request. The request body or one or more of the query parameters was not well formed. The `_error` field in the response will contain details about the request error. x-apiture-errors: - malformedRequestBodyBadRequest content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' '403': description: >- Forbidden. The caller does not have access to the requested resource or operation. The `_error` field in the response will contain details about the request error. x-apiture-errors: - invalidPartnerDomain content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' '412': description: >- Precondition Failed. The supplied `if-Match` header value does not match the most recent `ETag` response header value. The resource has changed in the interim. content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' '422': description: >- Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The `_error` field in the response will contain details about the request error. content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' 403Partner: description: >- Forbidden. The caller does not have access to the requested resource or operation. The `_error` field in the response will contain details about the request error. x-apiture-errors: - invalidPartnerDomain content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' 400Organization: description: Bad Request. The `organization` or `organizationUri` was malformed or does not refer to a partner organization. content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' 404Organization: description: >- Not Found. There is no such organization resource at the specified `{organizationId}`. The `_error` field in the response will contain details about the request error. content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' 409PartnerConflict: description: 'Conflict. Cannot create a new partner organization: there is already an existing partner with this `domain''.' content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' 409OrganizationConflict: description: |- Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following: * the `state` of a `removed` partner organization may not be changed. * the `state` cannot be updated via a `PUT` or `PATCH` request. Please use the appropriate operations to change the state. * some key fields of the partner organization record may not be changed or removed, such as their `domain`. * a partner organization may nt be deleted if it is in use by client applications. x-apiture-errors: - partnerOrganizationInUse - removedPartnerOrganizationImmutable content: application/hal+json: schema: $ref: '#/components/schemas/errorResponse' application/json: schema: $ref: '#/components/schemas/errorResponse' parameters: stateQueryParam: name: state in: query description: >- Subset the resources to only those whose `state` matches the query, such as `?state=active`. The value may be a `|` separated list of states, such as `?state=pending|active` to match all resources whose `state` is either `pending` _or_ `active`. If `?filter=` is also used, the two are combined with an implicit `and()` operation. style: pipeDelimited schema: type: array items: type: string enum: - pending - active - inactive - removed nameQueryParam: name: name in: query description: >- Subset the organizations collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell will match only items whose name is Bartell; ?name=Bartell|kirsten will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering). schema: type: string typeQueryParam: name: type in: query description: >- Subset the organizations collection to those with this exact type value. Use | to separate multiple values. For example, `?type=corporation` will match only items whose type is `corporation`; `?type=llp|llc` will match items whose type is `llp` or `llc`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering). schema: type: string organizationIdPathParam: name: organizationId description: The unique identifier of this organization. This is an opaque string. in: path required: true schema: type: string organizationQueryParam: name: organization description: >- A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or a organization URI. in: query required: true schema: type: string startQueryParam: name: start in: query description: >- Represents the first record of the page of results. This is supplied by the service when paginating items: the `next` link includes a `?start=` query parameter which refers to beginning of the next page of items. schema: type: string filterQueryParam: name: filter in: query description: 'Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).' schema: type: string ifMatchHeaderParam: name: If-Match description: The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource. in: header schema: type: string ifNoneMatchHeaderParam: name: If-None-Match description: >- The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned. in: header schema: type: string requestBodies: organization: content: application/hal+json: schema: $ref: '#/components/schemas/organization' application/json: schema: $ref: '#/components/schemas/organization' required: true securitySchemes: apiKey: type: apiKey name: API-Key in: header description: >- API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the `API-Key: {api-key}` request header. accessToken: type: oauth2 description: >- OAuth2 client access token authentication. The client authenticates against the server at `authorizationUrl`, passing the client's private `clientId` (and optional `clientSecret`) as part of this flow. The client obtains an access token from the server at `tokenUrl`. It then passes the received access token via the `Authorization: Bearer {access-token}` header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires. flows: authorizationCode: authorizationUrl: /auth/oauth2/authorize tokenUrl: /auth/oauth2/token scopes: profiles/read: Read access to partner related resources. profiles/write: Write (update) access to partner related resources. admin/delete: Administrator delete access to partner 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 partner related resources.