# Consumers

## Returns the list of directly connected consumers to consumer associated to provided organizationId.

 - [GET /v2/organizations/{id}/consumers](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_consumers.md): ⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.
The contract (fields, request/response structure, behavior) may change without notice.
All integrations consuming this endpoint must be updated accordingly.
This notice will be removed once the endpoint is stable.Security policies: OrganizationsConsumersView

## Create organization consumer (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of created consumer.

 - [POST /v2/organizations/{id}/consumers](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/post_v2_organizations_id_consumers.md): ⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.
The contract (fields, request/response structure, behavior) may change without notice.
All integrations consuming this endpoint must be updated accordingly.
This notice will be removed once the endpoint is stable.


⚠️ NOTE ON TAX CODE VALIDATION — This endpoint applies strict validation for supported countries
(currently IT and FR). If support for additional countries with strict tax code validation is introduced
in the future, this endpoint will automatically enforce those rules — callers must ensure tax codes are
valid for the consumer's country.Security policies: OrganizationsConsumersCreate

## Returns the detail of a consumer based on related consumer associated to given organization.

 - [GET /v2/organizations/{id}/consumers/{consumerId}](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_consumers_consumerid.md): ⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.
The contract (fields, request/response structure, behavior) may change without notice.
All integrations consuming this endpoint must be updated accordingly.
This notice will be removed once the endpoint is stable.Security policies: OrganizationsConsumerDetailsView

## Update organization consumer general infos and returns the identifier of updated consumer.

 - [PUT /v2/organizations/{id}/consumers/{consumerId}/general-infos](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_general-infos.md): ⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.
The contract (fields, request/response structure, behavior) may change without notice.
All integrations consuming this endpoint must be updated accordingly.
This notice will be removed once the endpoint is stable.Security policies: OrganizationsConsumersGeneralInfosEdit

## Update organization customer birth info and returns the identifier of updated customer..

 - [PUT /v1/organizations/{id}/consumers/{consumerId}/birth-infos](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_birth-infos.md): Security policies: OrganizationsConsumersBirthInfoEdit

## Update organization consumer residence info (V2 — PersonalCode) and returns the identifier of updated consumer.

 - [PUT /v2/organizations/{id}/consumers/{consumerId}/residence-infos](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_residence-infos.md): ⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.
The contract (fields, request/response structure, behavior) may change without notice.
All integrations consuming this endpoint must be updated accordingly.
This notice will be removed once the endpoint is stable.


⚠️ NOTE ON TAX CODE VALIDATION — This endpoint applies strict validation for supported countries
(currently IT and FR). If support for additional countries with strict tax code validation is introduced
in the future, this endpoint will automatically enforce those rules — callers must ensure tax codes are
valid for the consumer's country. Additionally, if the consumer's tax codes are already strictly
validated (IsValidatedTaxCodes = true), validation cannot regress — submitting codes that
would fail strict validation will return a 400 error.Security policies: OrganizationsConsumersResidenceInfoEdit, OrganizationsConsumersTaxDetailsEdit

## Update consumer billing infos and returns the identifier of updated consumer.

 - [PUT /v1/organizations/{id}/consumers/{consumerId}/billing-details](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_billing-details.md): Security policies: OrganizationsConsumersBillingDetailsEdit, OrganizationsConsumersContactInfosEdit

## Update consumer contact infos and returns the identifier of updated consumer.

 - [PUT /v1/organizations/{id}/consumers/{consumerId}/contact-infos](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_contact-infos.md): Security policies: OrganizationsConsumersContactInfosEdit

## Update organization consumer tax infos (V2 — TaxCode1/TaxCode2/TaxCode3) and returns the identifier of updated consumer.

 - [PUT /v2/organizations/{id}/consumers/{consumerId}/tax-details](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v2_organizations_id_consumers_consumerid_tax-details.md): ⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.
The contract (fields, request/response structure, behavior) may change without notice.
All integrations consuming this endpoint must be updated accordingly.
This notice will be removed once the endpoint is stable.


⚠️ NOTE ON TAX CODE VALIDATION — This endpoint applies strict validation for supported countries
(currently IT and FR). If support for additional countries with strict tax code validation is introduced
in the future, this endpoint will automatically enforce those rules — callers must ensure tax codes are
valid for the consumer's country. Additionally, if the consumer's tax codes are already strictly
validated (IsValidatedTaxCodes = true), validation cannot regress — submitting codes that
would fail strict validation will return a 400 error.Security policies: OrganizationsConsumersTaxDetailsEdit

## Update consumer additional infos and returns the identifier of updated consumer.

 - [PUT /v1/organizations/{id}/consumers/{consumerId}/additional-infos](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_additional-infos.md): Security policies: OrganizationsConsumersAdditionalInfosEdit

## Returns the list of associated users.

 - [GET /v1/organizations/{id}/consumers/{consumerId}/users](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers_consumerid_users.md): Security policies: OrganizationsConsumerDetailsView

## Returns the list of the contract consumers.

 - [GET /v2/organizations/{id}/contracts/{contractId}/consumers](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/get_v2_organizations_id_contracts_contractid_consumers.md): ⚠️ UNSTABLE ENDPOINT — This v2 endpoint is under active development.
The contract (fields, request/response structure, behavior) may change without notice.
All integrations consuming this endpoint must be updated accordingly.
This notice will be removed once the endpoint is stable.Security policies: OrganizationOrGlobalContractDetailsView

## Returns the list of directly connected consumers to consumer associated to provided organizationId (V1). (deprecated)

 - [GET /v1/organizations/{id}/consumers](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers.md): ⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/consumers' instead.Security policies: OrganizationsConsumersView

## Create organization consumer and returns the identifier of a consumer created. (deprecated)

 - [POST /v1/organizations/{id}/consumers](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/post_v1_organizations_id_consumers.md): ⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API POST '/v2/organizations/{id}/consumers' instead.Security policies: OrganizationsConsumersCreate

## Returns the detail of a consumer based on related consumer associated to given organization (V1). (deprecated)

 - [GET /v1/organizations/{id}/consumers/{consumerId}](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_consumers_consumerid.md): ⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/consumers/{consumerId}' instead.Security policies: OrganizationsConsumerDetailsView

## Update organization consumer general infos and returns the identifier of updated consumer. (deprecated)

 - [PUT /v1/organizations/{id}/consumers/{consumerId}/general-infos](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_general-infos.md): ⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-07-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/general-infos' instead.Security policies: OrganizationsConsumersGeneralInfosEdit

## Update organization customer residence info and returns the identifier of updated customer. (deprecated)

 - [PUT /v1/organizations/{id}/consumers/{consumerId}/residence-infos](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_residence-infos.md): ⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/residence-infos' instead.Security policies: OrganizationsConsumersResidenceInfoEdit, OrganizationsConsumersTaxDetailsEdit

## Update consumer tax infos and returns the identifier of updated consumer. (deprecated)

 - [PUT /v1/organizations/{id}/consumers/{consumerId}/tax-details](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/put_v1_organizations_id_consumers_consumerid_tax-details.md): ⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API PUT '/v2/organizations/{id}/consumers/{consumerId}/tax-details' instead.Security policies: OrganizationsConsumersTaxDetailsEdit

## Returns the list of the contract consumers (V1). (deprecated)

 - [GET /v1/organizations/{id}/contracts/{contractId}/consumers](https://docs.namirial.app/products/oneplatform/apis/oas/organizations/consumers/get_v1_organizations_id_contracts_contractid_consumers.md): ⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/contracts/{contractId}/consumers' instead.⚠️ DEPRECATED ⚠️: This API is DEPRECATED and will be removed on 2027-06-01, use API GET '/v2/organizations/{id}/contracts/{contractId}/consumers' instead.Security policies: OrganizationOrGlobalContractDetailsView