Credenciamento

Esta seção tem como objetivo descrever as etapas do processo de cadastramento de um portador (holder). Serão visitadas as APIs necessárias, as informações necessárias e o fluxo de negócio.

A rota da API para sandbox é: https://apigw-sandbox.zoop.ws/v2

Portador de conta de pagamentos

post
Cadastrar portador pessoa física

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
Body Parameters
cbo
required
string
Código de ocupação do portador da conta. Valor disponível em Listar CBO
type
required
string
Tipo do portador da conta. Para um holder pessoa física o valor deve ser sempre individual
pep
optional
boolean
Declaração se o portador da conta é uma pessoa exposta politicamente. Default=false
identity_card
optional
string
RG do portador da conta
mothers_name
required
string
Nome da mãe do portador da conta
birthday
required
string
Data de nascimento do portador da conta. formato: yyyy-mm-dd
revenue
required
string
Renda média do portador da conta
national_registration
required
string
CPF do portador da conta
email
required
string
email do portador da conta
name
required
string
Nome completo do portador da conta
Response
200: OK
{
"type":"individual",
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"marketplace_id":"d4d3fbbbc82d4a999c0a91261664b938",
"status":"waiting_documents",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"pep":false,
"cbo":212405,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents",
"type":"GET"
}
}
}
400: Bad Request
Alguma regra de negócio foi violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "business",
"status_code": 400,
"fields": {
"email": "Required field",
"establishment.format": "Not supported format"
}
}
404: Not Found
Marketplace não encontrado
{
"status": "not_found",
"type": "not_found",
"message": "Marketplace not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
Algum erro interno no servidor
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"type":"individual",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"pep":false,
"cbo":212405
}

put
Alterar cadastro de pessoa física

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do holder
Body Parameters
revenue
optional
string
Receita média do portador
birthday
optional
string
Data de nascimento do portador da conta. Formato yyyy-mm-dd
mothers_name
optional
string
Nome da mãe do portador da conta
cbo
optional
string
Código de ocupação do portador da conta. Valor disponível em listar CBO
Response
200: OK
{
"type":"individual",
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"marketplace_id":"d4d3fbbbc82d4a999c0a91261664b938",
"status":"waiting_documents",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":100.00,
"birthday":"1999-04-03",
"mothers_name":"Maria da Silva de souza",
"identity_card":"156022898",
"pep":false,
"cbo":848515,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents",
"type":"GET"
}
}
}
400: Bad Request
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "individual",
"status_code": 400,
"fields": {
"birthday":"99-04-03",
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"revenue":100.00,
"birthday":"1999-04-03",
"mothers_name":"Maria da Silva de souza",
"cbo":"848515",
}

post
Cadastrar portador pessoa jurídica

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
Body Parameters
type
required
string
Tipo do holder . Para um holder pessoa jurídica o valor deve ser sempre business
name
required
string
Nome fantasia da empresa.
email
required
string
E-mail da empresa
national_registration
required
string
CNPJ da empresa
revenue
required
string
Receita média da empresa
cnae
required
string
Código de classificação nacional de atividades econômicas
legal_name
required
string
Razão social da empresa
establishment.format
required
string
Formato de constituição da empresa. Valores possíveis: SS (Sociedade Simples), COOP (Sociedade Cooperativa), SPE (Sociedade de Propósito Especifico), LTDA (Sociedade Limitada), SA (Sociedade por Ações), ME (Micro empresa) , MEI (Microempreendedor individual), EI (Empresário individual), EIRELI (Empresário Individual de Responsabilidade Limitada) , SNC (Sociedade em Nome Coletivo), SCS (Sociedade em Comandita Simples), SCA (Sociedade em Comandita por Ações)
establishment.date
required
string
Data de constituição da empresa
Response
200: OK
{
"type":"business",
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"marketplace_id":"d4d3fbbbc82d4a999c0a91261664b938",
"status":"waiting_documents",
"name":"Teste",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"legal_name":"Teste Comercio de Alimentos Ltda.",
"establishment":{
"format":"ltda",
"date":"2001-03-05"
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/addresses",
"type":"GET"
},
"partners":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners",
"type":"GET"
},
"associates":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/associates",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents",
"type":"GET"
}
}
}
400: Bad Request
Alguma regra de negócio foi violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "business",
"status_code": 400,
"fields": {
"email": "Required field",
"establishment.format": "Not supported format"
}
}
404: Not Found
Algum recurso não encontrado
{
"status": "not_found",
"type": "not_found",
"message": "Marketplace not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
Algum erro interno no servidor
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"type":"business",
"name":"Teste",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"legal_name":"Teste Comercio de Alimentos Ltda.",
"establishment":{
"format":"LTDA",
"date":"2001-03-05"
}

put
Alterar cadastro de pessoa jurídica

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do holder
Body Parameters
revenue
optional
string
Receita média da empresa
legal_name
optional
string
Razão social da empresa
cnae
optional
string
Código de classificação nacional de atividades
establishment_date
optional
string
Data de constituição da empresa
Response
200: OK
{
"type":"business",
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"marketplace_id":"d4d3fbbbc82d4a999c0a91261664b938",
"status":"waiting_documents",
"name":"Teste",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":100.00,
"cnae":"0133404",
"legal_name":"Mbv Comercio de Alimentos Ltda 2",
"establishment":{
"format":"ltda",
"date":"2020-12-29"
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/addresses",
"type":"GET"
},
"partners":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners",
"type":"GET"
},
"associates":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/associates",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents",
"type":"GET"
}
}
}
400: Bad Request
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "individual",
"status_code": 400,
"fields": {
"birthday":"20-12-29",
}
}
404: Not Found
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"revenue":100.0,
"legal_name":"Mbv Comercio de Alimentos Ltda 2",
"cnae":"0133404",
"establishment_date":"2020-12-29",
}

post
Cadastrar telefone do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/phones
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do Marketplace
holderId
required
string
ID do portador da conta
Body Parameters
area_code
required
string
Código da área do telefone (DDD)
country_code
required
string
Código do país do telefone (DDI)
number
required
string
Número do telefone
Response
200: OK
{
"id": "a06f744df0944111b8da58daff18d8c2",
"area_code": "21",
"country_code": "55",
"number": "33093829",
"main": true,
"_links": {
"self": {
"href": "http://localhost/marketplaces/5ed320146b8248108c742cfa4bcac48e/banking/accreditation/holders/a391eb48b731455da7b9efe649b822ca/phones/a06f744df0944111b8da58daff18d8c2",
"type": "GET"
},
"holder": {
"href": "http://localhost/marketplaces/5ed320146b8248108c742cfa4bcac48e/banking/accreditation/holders/a391eb48b731455da7b9efe649b822ca",
"type": "GET"
}
}
}
400: Bad Request
Caso alguma regra de negócio dos dados seja violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "business",
"status_code": 400,
"fields": {
"number": "Number is required",
"country_code": "Country code must have only number characters"
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"area_code": "21",
"country_code": "55",
"number": "33093829"
}

post
Cadastrar endereço do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/addresses
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador da conta
Body Parameters
street
required
string
Logradouro do endereço
number
required
string
Número do endereço
city
required
string
Cidade do endereço
complement
optional
string
Complemento do endereço
state
required
string
Estado do endereço
neighborhood
required
string
Bairro do endereço
postal_code
required
string
CEP do endereço
country
required
string
Pais do endereço
Response
200: OK
{
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil"
}

post
Cadastrar documentos do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/documents?type=:type
Os unicos formatos de arquivos suportados são JPEG, PNG e PDF que devem ser declarado no parâmetro Content-Type do cabeçalho da requisição com um dos seguintes mime types correspondentes : image/jpeg, image/jpege image/jpeg.
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
type
required
string
Tipo do arquivo a ser enviado. Os tipos de arquivos são: SELFIE, RG_FRENTE, RG_VERSO, CNH_FRENTE, CNH-VERSO, CCMEI, PAGINA_CONTRATO_SOCIAL, PAGINA_ESTATUTO_SOCIAL, PAGINA_ATA_ELEICAO_DIRETORES, PAGINA_PROCURACAO
Headers
Content_type
required
string
Indica o tipo de conteúdo de acordo com o tipo de arquivo a ser enviado. Os tipos suportados são: image/jpeg, image/png e application/pdf
Response
201: Created
{
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"type":"SELFIE",
"format":"jpeg",
"size":1000000,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"download":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents/88c2d6c89ef24c4c861e2dbafc32336e/download",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
400: Bad Request
Alguma regra de negócio sobre a requisição for violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Invalid document format",
"category": "business",
"status_code": 400
}
404: Not Found
Algum recurso não encontrado. Ex: Marketplace, holder, owner
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
412: Precondition Failed
Não permitir inclusão de documentos para holders que não estejam no status WAITING_INFO, WAITING_DOCUMENTS ou WAITING_CORRECTIONS
{
"status": "pre_condition_failed",
"type": "invalid_request",
"message": "It is not possible to add documents to the holder in its current state. Contact support to make this request.",
"category": "business",
"status_code": 412
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
curl --location --request POST 'https://apigw-sandbox.zoop.ws/v2/marketplaces/19b2d3baf08f49cfbc292ae9b1990f25/banking/accreditation/holders/f8dfd0e3fcac44408d994e599c157a7c/documents?type=RG_FRENTE' \
--header 'Content-Type: image/jpeg' \
--data-binary '@/D:/Imagens/Selfie_icon.svg.png'

post
Solicitar aprovação do cadastro do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/approval
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
Response
202: Accepted
{"message":"Approval request accepted successfully. Processing analysis"}
404: Not Found
Algum recurso não encontrado. Ex: Marketplace ou holder
{
"status": "not_found",
"type": "not_found",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
411: Length Required
Alguma pré-condição violada
{
"status":"pre_condition_failed",
"type":"invalid_request",
"message":"Missing documents.",
"category":"business",
"status_code":412,
"documents":[
"Document type CCMEI is missing for holder 490f6c7c2b0b4046b3ec023c80923c0e",
"Document type SELFIE is missing for partner e6c915d443ec434db41b64c122afd9a7"
]
}
412: Precondition Failed
{
"status": "pre_condition_failed",
"type": "invalid_request",
"message": "Holder already approved.",
"category": "business",
"status_code": 412
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar portadores do marketplace

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
Response
200: OK
{
"_embedded": {
"holders": [
{
"id": "7511c3a224a04485b9f95b6c29e2030b",
"name": "João da Silva",
"revenue": 5500.5,
"email": "[email protected]",
"status": "waiting_info_and_documents",
"marketplace_id": "f8c2bfb884e4486c8e0eee15be5c3ab1",
"marketplace_name": "Marketplace Integração Testes Banking",
"created_at": "2020-09-25T16:35:25.264664",
"updated_at": "2020-09-25T16:35:25.264673",
"type": "individual",
"national_registration": "81970301708",
"birthday": "1985-08-20",
"mothers_name": "Maria da Silva",
"identity_card": "156032898",
"pep": false,
"cbo": "212405",
"_links": {
"self": {
"href": "https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/7511c3a224a04485b9f95b6c29e2030b",
"type": "GET"
},
"phones": {
"href": "https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/7511c3a224a04485b9f95b6c29e2030b/phones",
"type": "GET"
},
"addresses": {
"href": "https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/7511c3a224a04485b9f95b6c29e2030b/addresses",
"type": "GET"
},
"documents": {
"href": "https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/7511c3a224a04485b9f95b6c29e2030b/documents",
"type": "GET"
}
}
}

get
Consultar portador por id

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
Response
200: OK
{
"id": "a6d7c42c661b4e76bd6b77a9c09e82e1",
"name": "Anderson Silva",
"revenue": 15500.5,
"email": "[email protected]",
"status": "active",
"marketplace_id": "f8c2bfb884e4486c8e0eee15be5c3ab1",
"marketplace_name": "Marketplace Integração Testes Banking",
"created_at": "2020-09-25T16:35:29.425376",
"updated_at": "2020-10-01T15:29:53.69862",
"type": "individual",
"national_registration": "91034357093",
"birthday": "1972-09-18",
"mothers_name": "Maria da Silva",
"identity_card": "63036798001",
"pep": false,
"cbo": "212405",
"_links": {
"self": {
"href": "https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1",
"type": "GET"
},
"phones": {
"href": "https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/phones",
"type": "GET"
},
"addresses": {
"href": "https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/addresses",
"type": "GET"
},
"documents": {
"href": "https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/documents",
"type": "GET"
}
}
}

get
Consultar documento do portador por id

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/documents/:document_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
document_id
required
string
Id do documento
Response
200: OK
{
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"type":"SELFIE",
"format":"jpeg",
"size":1000000,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"download":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents/88c2d6c89ef24c4c861e2dbafc32336e/download",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
404: Not Found
{
"status": "not_found",
"type": "invalid_request",
"message": "Document not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar documentação do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/documents/
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
Response
200: OK
{
"_embedded":{
"documents":[
{
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"type":"SELFIE",
"format":"jpeg",
"size":1000000,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"download":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents/88c2d6c89ef24c4c861e2dbafc32336e/download",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
]
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents?page=0&size=20",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
}
},
"page":{
"size":20,
"total_elements":1,
"total_pages":1,
"number":0
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace ou holder
{
"status": "not_found",
"type": "invalid_request",
"message": "Document not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
Caso a requisição cause algum erro interno no servidor
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar endereço do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/addresses
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
Response
200: OK
{
"_embedded": {
"addresses": [
{
"id": "82865fbf83be47d083f26128ad0f77f6",
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil",
"main": true,
"_links": {
"self": {
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/addresses/82865fbf83be47d083f26128ad0f77f6",
"type": "GET"
},
"holder": {
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1",
"type": "GET"
}
}
}
]
},
"_links": {
"self": [
{
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/addresses?page=0&size=20",
"type": "GET"
},
{
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/addresses",
"type": "GET"
}
],
"holder": {
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1",
"type": "GET"
}
},
"page": {
"size": 20,
"total_elements": 1,
"total_pages": 1,
"number": 0
}
}
202: Accepted
{
"id":"e3cf13f2e87644b187f8830c421bb99b",
"street":"Av Atlância",
"number":"100",
"city":"Rio de Janeiro",
"complement":"Do lado Cittar América",
"state":"Rio de Janeiro",
"neighborhood":"Barra da Tijuca",
"postal_code":"22783450",
"country":"Brasil",
"main":false,
"_links":{
"self":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18/addresses/e3cf13f2e87644b187f8830c421bb99b",
"type":"GET"
},
"main":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18/addresses/e3cf13f2e87644b187f8830c421bb99b/main",
"type":"PUT"
},
"holder":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18",
"type":"GET"
}
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder, address
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar endereço do portador por id

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/addresses/:address_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
address_id
required
string
Id do endereço
Response
200: OK
Payload de um endereço principal
{
"id": "7f8ce51255774a969b4ce87754d5d8b9",
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil",
"main": true,
"_links": {
"self": {
"href": "http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/addresses/7f8ce51255774a969b4ce87754d5d8b9",
"type": "GET"
},
"holder": {
"href": "http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc",
"type": "GET"
}
}
}
202: Accepted
Payload de um endereço secundário
{
"id":"e3cf13f2e87644b187f8830c421bb99b",
"street":"Av Atlância",
"number":"100",
"city":"Rio de Janeiro",
"complement":"Do lado Cittar América",
"state":"Rio de Janeiro",
"neighborhood":"Barra da Tijuca",
"postal_code":"22783450",
"country":"Brasil",
"main":false,
"_links":{
"self":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18/addresses/e3cf13f2e87644b187f8830c421bb99b",
"type":"GET"
},
"main":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18/addresses/e3cf13f2e87644b187f8830c421bb99b/main",
"type":"PUT"
},
"holder":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18",
"type":"GET"
}
}
}
404: Not Found
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar telefone do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/phones
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
Response
200: OK
{
"_embedded": {
"phones": [
{
"id": "48150dee66994f06889180e2ae551f26",
"area_code": "21",
"country_code": "55",
"number": "33093829",
"main": true,
"_links": {
"self": {
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/phones/48150dee66994f06889180e2ae551f26",
"type": "GET"
},
"holder": {
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1",
"type": "GET"
}
}
}
]
},
"_links": {
"self": [
{
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/phones?page=0&size=20",
"type": "GET"
},
{
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/phones",
"type": "GET"
}
],
"holder": {
"href": "https://api-beta.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1",
"type": "GET"
}
},
"page": {
"size": 20,
"total_elements": 1,
"total_pages": 1,
"number": 0
}
}

put
Alterar telefone do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/phones/:phone_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
phone_id
required
string
Id do telefone
Response
200: OK
{
"id": "a06f744df0944111b8da58daff18d8c2",
"area_code": "21",
"country_code": "55",
"number": "33093829",
"main": true,
"_links": {
"self": {
"href": "http://localhost/marketplaces/5ed320146b8248108c742cfa4bcac48e/banking/accreditation/holders/a391eb48b731455da7b9efe649b822ca/phones/a06f744df0944111b8da58daff18d8c2",
"type": "GET"
},
"holder": {
"href": "http://localhost/marketplaces/5ed320146b8248108c742cfa4bcac48e/banking/accreditation/holders/a391eb48b731455da7b9efe649b822ca",
"type": "GET"
}
}
}
201: Created
Payload de telefone secundário
{
"id": "6e5d49ca5af1444fb2baa1f1d3bdb81d",
"area_code": "21",
"country_code": "55",
"number": "98767777",
"main": false,
"_links": {
"self": {
"href": "http://localhost/marketplaces/918352aeab3e48b7b1f1c941fe259b25/banking/accreditation/holders/55ff35bd0df840ca96360c15cb6c06c4/phones/6e5d49ca5af1444fb2baa1f1d3bdb81d",
"type": "GET"
},
"main": {
"href": "http://localhost/marketplaces/918352aeab3e48b7b1f1c941fe259b25/banking/accreditation/holders/55ff35bd0df840ca96360c15cb6c06c4/phones/6e5d49ca5af1444fb2baa1f1d3bdb81d/main",
"type": "PUT"
},
"holder": {
"href": "http://localhost/marketplaces/918352aeab3e48b7b1f1c941fe259b25/banking/accreditation/holders/55ff35bd0df840ca96360c15cb6c06c4",
"type": "GET"
}
}
}
400: Bad Request
Caso alguma regra de negócio dos dados seja violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "business",
"status_code": 400,
"fields": {
"number": "Number is required",
"country_code": "Country code must have only number characters"
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"area_code": "21",
"country_code": "55",
"number": "33093829"
}

delete
Excluir telefone do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/phones/:phone_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do holder
phone_id
required
string
Id do telefone
Response
200: OK
{
"message": "Phone removed successfully"
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder, phone
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
412: Precondition Failed
Caso alguma regra de negócio pré existente seja violada
{
"status": "precondition_failed",
"type": "invalid_request",
"message": "At least one phone must be remaining",
"category": "business",
"status_code": 412
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

delete
Excluir documento do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/documents/:document_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
document_id
required
string
Id do documento
Response
200: OK
Arquivo excluído com sucesso
{ "message":"Document removed successfully" }
400: Bad Request
Alguma regra de negócio violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Invalid document owner",
"category": "business",
"status_code": 400
}
404: Not Found
Algum recurso não encontrado. Ex: Marketplace, holder ou document
{
"status": "not_found",
"type": "invalid_request",
"message": "Document not found",
"category": "business",
"status_code": 404
}
412: Precondition Failed
Não permitir inclusão de documentos para holders que não estejam no status WAITING_INFO, WAITING_DOCUMENTS ou WAITING_CORRECTIONS
{
"status": "pre_condition_failed",
"type": "invalid_request",
"message": "It is not possible to remove documents to the holder in its current state. Contact support to make this request.",
"category": "business",
"status_code": 412
}
500: Internal Server Error
A requisição causou um erro interno no servidor
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

put
Alterar endereço do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/addresses/:address_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
address_id
required
string
Id do endereço
Response
200: OK
{
"id": "7f8ce51255774a969b4ce87754d5d8b9",
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil",
"main": true,
"_links": {
"self": {
"href": "http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/addresses/7f8ce51255774a969b4ce87754d5d8b9",
"type": "GET"
},
"holder": {
"href": "http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc",
"type": "GET"
}
}
}
202: Accepted
Payload de um endereço secundário
{
"id":"e3cf13f2e87644b187f8830c421bb99b",
"street":"Av Atlância",
"number":"100",
"city":"Rio de Janeiro",
"complement":"Do lado Cittar América",
"state":"Rio de Janeiro",
"neighborhood":"Barra da Tijuca",
"postal_code":"22783450",
"country":"Brasil",
"main":false,
"_links":{
"self":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18/addresses/e3cf13f2e87644b187f8830c421bb99b",
"type":"GET"
},
"main":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18/addresses/e3cf13f2e87644b187f8830c421bb99b/main",
"type":"PUT"
},
"holder":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/679d752a93f946568d6581908e07fb18",
"type":"GET"
}
}
}
400: Bad Request
Caso alguma regra de negócio dos dados seja violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "business",
"status_code": 400,
"fields": {
"state": "State is required",
"posta_code": "Postal code must have only number characters"
}
}
404: Not Found
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil"
}

delete
Excluir endereço do portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/addresses/:address_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
address_id
optional
string
id do endereço
Response
200: OK
{
"message": "Address removed successfully"
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder, address
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
412: Precondition Failed
Caso alguma regra de negócio pré existente seja violada
{
"status": "precondition_failed",
"type": "invalid_request",
"message": "At least one address must be remaining",
"category": "business",
"status_code": 412
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

Sócio

Todo portador PJ (business holder) deve cadastrar todos os sócios da empresa. Para isso utilize os passos abaixo.

post
Cadastrar sócio

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do holder
Body Parameters
percentage
required
number
Indica o percentual de controle da empresa pelo sócio
adm
required
boolean
Indica se o sócio é o administrador da empresa
type
required
string
Tipo do sócio. As possibilidades são "individual" para PF ou "business" para PJ
name
required
string
Nome completo caso PF (individual) e Razão Social caso PJ (business)
email
required
string
email do sócio
national_registration
required
number
CPF para PF ou CNPJ para PJ
revenue
required
string
Renda média para PF ou Receita para PJ
birthday
required
string
Data de nascimento para PF ou Data de abertura da empresa para PJ
mothers_name
required
string
Nome da mãe
owner
optional
string
ID do sócio. Só preencher caso o portador seja um PJ que tenha como sócio outro PJ e esse sócio tenha como sócio uma PF
identity_card
optional
string
RG em caso de PF
pep
optional
boolean
Pessoa exposta publicamente? Default=false
cbo
required
string
Código de ocupação do sócio
Response
200: OK
Payload para um individual partner sem owner
{
"type":"individual",
"id":"0b4a40d89e004b4bba626c50e2dd77f2",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"main": true,
"pep":false,
"cbo":212405,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336epartners/0b4a40d89e004b4bba626c50e2dd77f2/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/documents",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
201: Created
Para um individual partner com owner
{
"type":"individual",
"id":"0b4a40d89e004b4bba626c50e2dd77f2",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"main": false,
"identity_card":"156022898",
"pep":false,
"cbo":212405,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336epartners/0b4a40d89e004b4bba626c50e2dd77f2/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/documents",
"type":"GET"
},
"main":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/main",
"type":"PUT"
},
"owner":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/8c7f39c7670f477aa2d260393180f5f7",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
202: Accepted
Payload para um business partner sem owner
{
"type":"business",
"id":"446776742bf945f78f2061d7ae7cf0d0",
"name":"China in Box",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"main": true,
"legal_name":"Mbv Comercio de Alimentos Ltda.",
"establishment":{
"format":"ltda",
"date":"2001-03-05"
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/documents",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
302: Found
Payload para um business partner com owner
{
"type":"business",
"id":"446776742bf945f78f2061d7ae7cf0d0",
"name":"China in Box",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"main":false,
"legal_name":"Mbv Comercio de Alimentos Ltda.",
"establishment":{
"format":"ltda",
"date":"2001-03-05"
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/documents",
"type":"GET"
},
"main":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/main",
"type":"PUT"
},
"owner":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/8c7f39c7670f477aa2d260393180f5f7",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
400: Bad Request
Caso alguma regra de negócio dos dados seja violada.
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "business",
"status_code": 400,
"fields": {
"national_registration": "National registration is required",
"birthday": "Birthday must be a past date"
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
412: Precondition Failed
Caso alguma regra de negócio pré existente seja violada
{
"status": "precondition_failed",
"type": "invalid_request",
"message": "Current holder status forbbid partners addition",
"category": "business",
"status_code": 412
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

Para um individual partner (sócio pessoa física) :

{
"type":"individual",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"pep":false,
"cbo":212405,
"percentage": 100,
"adm":true
}

Para um business partner (sócio pessoa jurídica) :

{
"type":"business",
"name":"China in Box",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"owner":null,
"legal_name":"Mbv Comercio de Alimentos Ltda.",
"establishment":{
"format":"LTDA",
"date":"2001-03-05"
},
"percentage": 100,
"adm": true
}

post
Cadastrar telefone de sócio

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners/:partnerId/phones
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador da conta
partnerId
required
string
ID do sócio
Body Parameters
contry_code
required
string
DDI
area_code
required
string
DDD
number
required
string
Número do telefone
Response
201: Created
{
"id":"a06f744df0944111b8da58daff18d8c2",
"area_code":"21",
"country_code":"55",
"number":"33093829",
"main":true,
"_links":{
"self":{
"href":"http://localhost/marketplaces/5ed320146b8248108c742cfa4bcac48e/banking/accreditation/holders/a391eb48b731455da7b9efe649b822ca/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e/phones/a06f744df0944111b8da58daff18d8c2",
"type":"GET"
},
"partner":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e336e",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/5ed320146b8248108c742cfa4bcac48e/banking/accreditation/holders/a391eb48b731455da7b9efe649b822ca",
"type":"GET"
}
}
}
400: Bad Request
Caso alguma regra de negócio dos dados seja violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "business",
"status_code": 400,
"fields": {
"number": "Number is required",
"country_code": "Country code must have only number characters"
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"area_code": "21",
"country_code": "55",
"number": "33093829"
}

post
Cadastrar endereço de sócio

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners/:partnerId/addresses
Request
Response
Request
Path Parameters
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador da conta
partnerId
required
string
ID do sócio
Body Parameters
street
required
string
Logradouro
number
required
number
Número. Preencha com 0, caso não tenha número
city
required
string
Cidade
complement
optional
string
Complemento do endereço
state
required
string
Estado
neighborhood
required
string
Bairro
postal_code
required
number
CEP. Somente números
country
required
string
País
Response
201: Created
{
"type":"individual",
"id":"0b4a40d89e004b4bba626c50e2dd77f2",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"main": true,
"pep":false,
"cbo":212405,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336epartners/0b4a40d89e004b4bba626c50e2dd77f2/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/documents",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
400: Bad Request
Caso alguma regra de negócio dos dados seja violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Validation field error",
"category": "business",
"status_code": 400,
"fields": {
"state": "State is required",
"posta_code": "Postal code must have only number characters"
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
{
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil"
}

post
Cadastrar documento de sócio

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partners/:partnerId/documents
Os formatos de arquivos suportados são JPEG, PNG e PDF que devem ser declarado no parâmetro Content-Type do cabeçalho da requisição com um dos seguintes mime types correspondentes : image/jpeg, image/png e application/pdf.
Request
Response
Request
Path Parameters
type
required
string
Documentos possíveis: SELFIE, RG_VERSO, CNH_FRENTE, CNH_VERSO, CCMEI, PAGINA_CONTRATO_SOCIAL, PAGINA_ESTATUTO_SOCIAL, PAGINA_ATA_ELEICAO_DIRETORES, PAGINA_PROCURACAO
marketplaceId
required
string
ID do marketplace
holderId
required
string
ID do portador da conta
partnerId
required
string
ID do sócio
Headers
Content_type
required
string
Indicar o tipo de conteúdo de acordo com o tipo de arquivo a ser enviado. Os tipos suportados são: image/jpeg, image/png e application/pdf
Response
201: Created
{
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"type":"SELFIE",
"format":"jpeg",
"size":1000000,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/3f212e836380479cae23b0330b9694af/documents/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"download":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/3f212e836380479cae23b0330b9694af/documents/88c2d6c89ef24c4c861e2dbafc32336e/download",
"type":"GET"
},
"partner":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/3f212e836380479cae23b0330b9694af",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
400: Bad Request
Alguma regra de negócio sobre a requisição for violada
{
"status": "bad_request",
"type": "invalid_request",
"message": "Invalid document format",
"category": "business",
"status_code": 400
}
404: Not Found
Algum recurso não encontrado. Ex: Marketplace, holder, owner
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
412: Precondition Failed
Não permitir inclusão de documentos para sócios cujo o holder não estejam no status WAITING_INFO, WAITING_DOCUMENTS ou WAITING_CORRECTIONS
{
"status": "pre_condition_failed",
"type": "invalid_request",
"message": "It is not possible to add documents to the partner due to the holder status. Contact support to make this request.",
"category": "business",
"status_code": 412
}
500: Internal Server Error
A requisição causou um erro interno no servidor
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}
curl --location --request POST 'httcurl --location --request POST 'https://apigw-sandbox.zoop.ws/v2/marketplaces/f8c2bfb884e4486c8e0eee15be5c3ab1/banking/accreditation/holders/a6d7c42c661b4e76bd6b77a9c09e82e1/partners/e9d7c42c661b4e76bd6b77a9c09e82c1/documents?type=SELFIE' \
--header 'Content-Type: image/jpeg' \
--data-binary '@/D:/Imagens/Selfie_icon.svg.png'

get
Consultar sócio por id

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partners/:partner_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
partner_id
required
string
Id do sócio
Response
200: OK
Payload para um individual partner sem owner
{
"type":"individual",
"id":"0b4a40d89e004b4bba626c50e2dd77f2",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"main": true,
"pep":false,
"cbo":212405,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336epartners/0b4a40d89e004b4bba626c50e2dd77f2/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/documents",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
201: Created
Para um individual partner com owner
{
"type":"individual",
"id":"0b4a40d89e004b4bba626c50e2dd77f2",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"main": false,
"identity_card":"156022898",
"pep":false,
"cbo":212405,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336epartners/0b4a40d89e004b4bba626c50e2dd77f2/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/documents",
"type":"GET"
},
"main":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/0b4a40d89e004b4bba626c50e2dd77f2/main",
"type":"PUT"
},
"owner":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/8c7f39c7670f477aa2d260393180f5f7",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
202: Accepted
Payload para um business partner sem owner
{
"type":"business",
"id":"446776742bf945f78f2061d7ae7cf0d0",
"name":"China in Box",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"main": true,
"legal_name":"Mbv Comercio de Alimentos Ltda.",
"establishment":{
"format":"ltda",
"date":"2001-03-05"
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/documents",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
302: Found
Payload para um business partner com owner
{
"type":"business",
"id":"446776742bf945f78f2061d7ae7cf0d0",
"name":"China in Box",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"main":false,
"legal_name":"Mbv Comercio de Alimentos Ltda.",
"establishment":{
"format":"ltda",
"date":"2001-03-05"
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/documents",
"type":"GET"
},
"main":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/446776742bf945f78f2061d7ae7cf0d0/main",
"type":"PUT"
},
"owner":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/8c7f39c7670f477aa2d260393180f5f7",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar sócios de um portador

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/partners?page=0&size=20
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
page
optional
number
indica a página que será exibida
size
optional
number
Quantidade de registros a ser retornado por página
Response
200: OK
{
"_embedded":{
"partners":[
{
"type":"individual",
"id":"8299cbec94fe4732b860f54fbefd349c ",
"name":"João da Silva",
"email":"[email protected]",
"national_registration":"10057698007",
"revenue":5500.50,
"birthday":"1985-08-20",
"mothers_name":"Maria da Silva",
"identity_card":"156022898",
"main":true,
"pep":false,
"cbo":212405,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/8299cbec94fe4732b860f54fbefd349c",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/8299cbec94fe4732b860f54fbefd349c/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/8299cbec94fe4732b860f54fbefd349c/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/8299cbec94fe4732b860f54fbefd349c/documents",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
}
}
},
{
"type":"business",
"id":"857ca751b26448438a9ba1db03e7a3b2",
"name":"China in Box",
"email":"[email protected]",
"national_registration":"67053773000107",
"revenue":15000.50,
"cnae":"0111301",
"main":false,
"legal_name":"Mbv Comercio de Alimentos Ltda.",
"establishment":{
"format":"ltda",
"date":"2001-03-05"
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/857ca751b26448438a9ba1db03e7a3b2",
"type":"GET"
},
"phones":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/857ca751b26448438a9ba1db03e7a3b2/phones",
"type":"GET"
},
"addresses":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/857ca751b26448438a9ba1db03e7a3b2/addresses",
"type":"GET"
},
"documents":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/857ca751b26448438a9ba1db03e7a3b2/documents",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
}
}
}
]
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/5eb0be4b-2119-4827-a05e-8811635fba41/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/?page=0&size=20",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/4214147f5997473abe8e6e1b3e95b5c1/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
}
},
"page":{
"size":20,
"total_elements":2,
"total_pages":1,
"number":0
}
}
404: Not Found
Caso algum recurso ou informação não seja encontrada. Ex: Marketplace
{
"status": "not_found",
"type": "invalid_request",
"message": "Marketplace not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
Caso a requisição cause algum problema interno na aplicação
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar documentação do sócio

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/partners/:partner_id/documents/
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
partner_id
required
string
Id do sócio
Response
200: OK
{
"_embedded":{
"documents":[
{
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"type":"SELFIE",
"format":"jpeg",
"size":1000000,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/3f212e836380479cae23b0330b9694af/documents/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"download":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/3f212e836380479cae23b0330b9694af/documents/88c2d6c89ef24c4c861e2dbafc32336e/download",
"type":"GET"
},
"partner":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/3f212e836380479cae23b0330b9694af",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
]
},
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/3f212e836380479cae23b0330b9694af/documents?page=0&size=20",
"type":"GET"
},
"partner":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/partners/3f212e836380479cae23b0330b9694af",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
}
},
"page":{
"size":20,
"total_elements":1,
"total_pages":1,
"number":0
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder, partner
{
"status": "not_found",
"type": "invalid_request",
"message": "Partner not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
Caso a requisição cause algum erro interno no servidor
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar documento do sócio por id

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_id/partners/:partner_id/documents/:document_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
partner_id
required
string
Id do sócio
document_id
required
string
Id do documento
Response
200: OK
{
"id":"88c2d6c89ef24c4c861e2dbafc32336e",
"type":"SELFIE",
"format":"jpeg",
"size":1000000,
"_links":{
"self":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents/88c2d6c89ef24c4c861e2dbafc32336e",
"type":"GET"
},
"download":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/documents/88c2d6c89ef24c4c861e2dbafc32336e/download",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/d4d3fbbbc82d4a999c0a91261664b938/banking/accreditation/holders/88c2d6c89ef24c4c861e2dbafc32336e/",
"type":"GET"
}
}
}
404: Not Found
{
"status": "not_found",
"type": "invalid_request",
"message": "Document not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar endereço de sócio por id

https://api-beta.zoop.ws/v2/marketplaces/:marketplace_id/banking/accreditation/holders/:holder_Id/partner/:partner_id/address/:address_id
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do holder
partner_id
required
string
Id do sócio
address_id
required
string
Id do endereço
Response
200: OK
Payload de um endereço principal:
{
"id": "7f8ce51255774a969b4ce87754d5d8b9",
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil",
"main": true,
"_links": {
"self": {
"href": "http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e336e/addresses/7f8ce51255774a969b4ce87754d5d8b9",
"type": "GET"
},
"partner":{
"href":"http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e336e",
"type":"GET"
},
"holder": {
"href": "http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc",
"type": "GET"
}
}
}
201: Created
Payload de um endereço secundário:
{
"id": "7f8ce51255774a969b4ce87754d5d8b9",
"street": "Av da América",
"number": "100",
"city": "Rio de Janeiro",
"complement": "Do lado Cittar América",
"state": "Rio de Janeiro",
"neighborhood": "Barra da Tijuca",
"postal_code": "22783450",
"country": "Brasil",
"main": false,
"_links": {
"self": {
"href": "http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e336e/addresses/7f8ce51255774a969b4ce87754d5d8b9",
"type": "GET"
},
"main":{
"href":"http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e336e/addresses/7f8ce51255774a969b4ce87754d5d8b9/main",
"type":"PUT"
},
"partner":{
"href":"http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e336e",
"type":"GET"
},
"holder": {
"href": "http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc",
"type": "GET"
}
}
}
404: Not Found
Caso algum recurso não seja encontrado. Ex: Marketplace, holder, address
{
"status": "not_found",
"type": "invalid_request",
"message": "Holder not found",
"category": "business",
"status_code": 404
}
500: Internal Server Error
{
"status": "internal_server_error",
"type": "server_error",
"message": "Internal Server Error",
"category": "unexpected",
"status_code": 500
}

get
Consultar endereços do sócio

https://api-beta.zoop.ws/v2/marketplaces/:marketplaceId/banking/accreditation/holders/:holderId/partenrs/:partenrId/addresses
Request
Response
Request
Path Parameters
marketplace_id
required
string
Id do marketplace
holder_id
required
string
Id do portador
partner_id
required
string
Id do sócio
Response
200: OK
{
"_embedded":{
"addresses":[
{
"id":"7f8ce51255774a969b4ce87754d5d8b9",
"street":"Av da América",
"number":"100",
"city":"Rio de Janeiro",
"complement":"Do lado Cittar América",
"state":"Rio de Janeiro",
"neighborhood":"Barra da Tijuca",
"postal_code":"22783450",
"country":"Brasil",
"main":true,
"_links":{
"self":{
"href":"http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e336e/addresses/7f8ce51255774a969b4ce87754d5d8b9",
"type":"GET"
},
"partner":{
"href":"http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc/partners/82a2be6013ef4b01aaa8dcb4efcd6a8e336e",
"type":"GET"
},
"holder":{
"href":"http://localhost/marketplaces/3870ad88698f4918b87674e3a60318f5/banking/accreditation/holders/e0171891d18940699716d9f5581977cc",
"type":"GET"
}
}
},
{
"id":"6ad57c637e0441929ae5d9e048308b56",
"street":"Av da América",