{"openapi":"3.1.0","info":{"title":"Arbol ADRES","version":"1.3.0"},"servers":[{"url":"https://adres.getarbol.com"}],"tags":[{"name":"Affiliations"}],"paths":{"/v1/affiliations/lookup":{"post":{"operationId":"lookupAffiliation","summary":"Look up EPS affiliation","description":"Get one authorized person's identification, location, EPS affiliations and official Sisbén classification. Use the supplied document type and number. The response includes observation time, source and verification.","tags":["Affiliations"],"security":[{"oauth2":["adres:affiliations:read"]}],"x-required-scopes":["adres:affiliations:read"],"x-effect":"read","x-mcp-tool":"lookup_affiliation","x-mcp-idempotent":false,"x-mcp-open-world":true,"x-native-rpc":true,"x-max-body-bytes":1024,"x-max-output-bytes":262144,"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupAffiliationInput"}}}},"responses":{"200":{"description":"Successful operation.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliationLookupResponse"}}}},"400":{"description":"`INVALID_INPUT`: The request does not match the published schema.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["INVALID_INPUT"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputError"}}}},"401":{"description":"`UNAUTHORIZED`: A valid access token is required.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["UNAUTHORIZED"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"`FORBIDDEN`: The token does not authorize this operation.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["FORBIDDEN"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"409":{"description":"`LOOKUP_IN_PROGRESS`: A lookup for this document is in progress.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"Retry-After":{"$ref":"#/components/headers/RetryAfter"}},"x-failure-codes":["LOOKUP_IN_PROGRESS"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupInProgressError"}}}},"413":{"description":"`REQUEST_TOO_LARGE`: The request exceeds the allowed size.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["REQUEST_TOO_LARGE"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestTooLargeError"}}}},"415":{"description":"`UNSUPPORTED_MEDIA_TYPE`: The request content type is not supported.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["UNSUPPORTED_MEDIA_TYPE"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeError"}}}},"429":{"description":"`RATE_LIMITED`: The request rate limit was exceeded. Try again later.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"},"Retry-After":{"$ref":"#/components/headers/RetryAfter"}},"x-failure-codes":["RATE_LIMITED"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitedError"}}}},"500":{"description":"`INTERNAL_ERROR`: The service could not complete the operation.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["INTERNAL_ERROR"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}},"502":{"description":"- `OUTCOME_UNKNOWN`: The operation may have been applied; check its result before repeating it.\n- `CAPTCHA_REJECTED`: ADRES did not accept the verification. No affiliation was determined.\n- `ADRES_RESPONSE_UNRECOGNIZED`: The ADRES response could not be verified for this document. No affiliation was determined.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["OUTCOME_UNKNOWN","CAPTCHA_REJECTED","ADRES_RESPONSE_UNRECOGNIZED"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupAffiliationBadGatewayError"}}}},"503":{"description":"- `UPSTREAM_UNAVAILABLE`: The upstream service could not complete the request.\n- `LOOKUP_UNAVAILABLE`: This lookup is temporarily unavailable.\n- `CAPTCHA_UNAVAILABLE`: The CAPTCHA provider could not complete this challenge. Do not retry automatically.\n- `ADRES_UNAVAILABLE`: ADRES did not complete the consultation. No affiliation was determined.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["UPSTREAM_UNAVAILABLE","LOOKUP_UNAVAILABLE","CAPTCHA_UNAVAILABLE","ADRES_UNAVAILABLE"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupAffiliationServiceUnavailableError"}}}},"504":{"description":"`UPSTREAM_TIMEOUT`: The upstream service did not respond before its deadline.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}},"x-failure-codes":["UPSTREAM_TIMEOUT"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpstreamTimeoutError"}}}}}}}},"components":{"schemas":{"AdresResponseUnrecognizedFailure":{"type":"object","description":"The ADRES response could not be verified for this document. No affiliation was determined.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["ADRES_RESPONSE_UNRECOGNIZED"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"AdresUnavailableFailure":{"type":"object","description":"ADRES did not complete the consultation. No affiliation was determined.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["ADRES_UNAVAILABLE"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"AffiliatedPerson":{"additionalProperties":false,"type":"object","required":["documentType","documentNumber","givenNames","surnames","fullName","birthDate","department","municipality","reportedFields"],"properties":{"documentType":{"default":"CC","description":"CC ciudadanía, CE extranjería, TI tarjeta de identidad, RC registro civil, CN certificado de nacido vivo, NU número único, MS menor sin identificación. Use the type on the document. Defaults to CC.","anyOf":[{"const":"CC","type":"string"},{"const":"CE","type":"string"},{"const":"TI","type":"string"},{"const":"RC","type":"string"},{"const":"CN","type":"string"},{"const":"NU","type":"string"},{"const":"MS","type":"string"}]},"documentNumber":{"maxLength":14,"type":"string"},"givenNames":{"anyOf":[{"minLength":1,"maxLength":512,"type":"string"},{"type":"null"}]},"surnames":{"anyOf":[{"minLength":1,"maxLength":512,"type":"string"},{"type":"null"}]},"fullName":{"anyOf":[{"minLength":1,"maxLength":512,"type":"string"},{"type":"null"}]},"birthDate":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}]},"department":{"anyOf":[{"minLength":1,"maxLength":512,"type":"string"},{"type":"null"}]},"municipality":{"anyOf":[{"minLength":1,"maxLength":512,"type":"string"},{"type":"null"}]},"reportedFields":{"maxItems":48,"description":"Labeled cells as displayed in the verified ADRES report, including masked values.","type":"array","items":{"additionalProperties":false,"type":"object","required":["label","value"],"properties":{"label":{"minLength":1,"maxLength":128,"type":"string"},"value":{"maxLength":512,"type":"string"}}}}}},"Affiliation":{"additionalProperties":false,"type":"object","required":["eps","status","regime","affiliateType","effectiveDate","endDate","endDateKind","isExpired","reportedFields"],"properties":{"eps":{"minLength":1,"maxLength":500,"type":"string"},"status":{"minLength":1,"maxLength":80,"type":"string"},"regime":{"minLength":1,"maxLength":100,"type":"string"},"affiliateType":{"anyOf":[{"minLength":1,"maxLength":512,"type":"string"},{"type":"null"}]},"effectiveDate":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}]},"endDate":{"anyOf":[{"format":"date","type":"string"},{"type":"null"}]},"endDateKind":{"anyOf":[{"const":"dated","type":"string"},{"const":"open_ended","type":"string"},{"const":"not_reported","type":"string"}]},"isExpired":{"description":"Whether the reported end date has passed on the Colombian calendar at response time. False for ADRES's open-ended date. Read status separately.","anyOf":[{"type":"boolean"},{"type":"null"}]},"reportedFields":{"maxItems":48,"description":"Labeled cells as displayed in the verified ADRES report, including masked values.","type":"array","items":{"additionalProperties":false,"type":"object","required":["label","value"],"properties":{"label":{"minLength":1,"maxLength":128,"type":"string"},"value":{"maxLength":512,"type":"string"}}}}}},"AffiliationLookup":{"anyOf":[{"additionalProperties":false,"type":"object","required":["consultedAt","source","sisben","outcome","person","affiliations","verification","countryCode"],"properties":{"consultedAt":{"format":"date-time","description":"Timestamp of the observation returned.","type":"string"},"source":{"pattern":"^[A-Z][A-Z0-9_:-]{1,63}$","description":"Identifier of the source that supplied this observation.","type":"string"},"sisben":{"additionalProperties":false,"description":"The official field comes from DNP. status and value reflect the evidence in the underlying affiliation report.","type":"object","required":["status","value","official"],"properties":{"status":{"anyOf":[{"const":"reported","type":"string"},{"const":"explicitly_absent","type":"string"},{"const":"not_reported","type":"string"}]},"value":{"anyOf":[{"minLength":1,"maxLength":512,"type":"string"},{"type":"null"}]},"official":{"$ref":"#/components/schemas/OfficialSisbenClassification","description":"DNP registration and official household classification. Null registration means unknown. Use its own observation timestamp."}}},"outcome":{"const":"found","type":"string"},"person":{"$ref":"#/components/schemas/AffiliatedPerson"},"affiliations":{"minItems":1,"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/Affiliation"}},"verification":{"description":"For last_known, explicitly tell the user the observation date. Do not claim this affiliation is current.","anyOf":[{"const":"source_report","type":"string"},{"const":"last_known","type":"string"}]},"countryCode":{"description":"ISO country code of the issuing country. Currently Colombia.","const":"CO","type":"string"}}},{"additionalProperties":false,"type":"object","required":["consultedAt","source","sisben","outcome","person","affiliations","verification","countryCode"],"properties":{"consultedAt":{"format":"date-time","description":"Timestamp of the observation returned.","type":"string"},"source":{"pattern":"^[A-Z][A-Z0-9_:-]{1,63}$","description":"Identifier of the source that supplied this observation.","type":"string"},"sisben":{"additionalProperties":false,"description":"The official field comes from DNP. status and value reflect the evidence in the underlying affiliation report.","type":"object","required":["status","value","official"],"properties":{"status":{"anyOf":[{"const":"reported","type":"string"},{"const":"explicitly_absent","type":"string"},{"const":"not_reported","type":"string"}]},"value":{"anyOf":[{"minLength":1,"maxLength":512,"type":"string"},{"type":"null"}]},"official":{"$ref":"#/components/schemas/OfficialSisbenClassification","description":"DNP registration and official household classification. Null registration means unknown. Use its own observation timestamp."}}},"outcome":{"const":"not_found","type":"string"},"person":{"type":"null"},"affiliations":{"maxItems":0,"type":"array","items":{"$ref":"#/components/schemas/Affiliation"}},"verification":{"description":"For last_known, explicitly tell the user the observation date. Do not claim this affiliation is current.","anyOf":[{"const":"source_report","type":"string"},{"const":"last_known","type":"string"}]},"countryCode":{"description":"ISO country code of the issuing country. Currently Colombia.","const":"CO","type":"string"}}}]},"AffiliationLookupResponse":{"type":"object","description":"A successful answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"$ref":"#/components/schemas/AffiliationLookup"},"error":{"const":null},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"CaptchaRejectedFailure":{"type":"object","description":"ADRES did not accept the verification. No affiliation was determined.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["CAPTCHA_REJECTED"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"CaptchaUnavailableFailure":{"type":"object","description":"The CAPTCHA provider could not complete this challenge. Do not retry automatically.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["CAPTCHA_UNAVAILABLE"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"Empty":{"type":"object","description":"No fields.","additionalProperties":false,"properties":{}},"ForbiddenError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/ForbiddenFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"ForbiddenFailure":{"type":"object","description":"The token does not authorize this operation.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["FORBIDDEN"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"InternalError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/InternalFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"InternalFailure":{"type":"object","description":"The service could not complete the operation.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"InvalidInputError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/InvalidInputFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"InvalidInputFailure":{"type":"object","description":"The request does not match the published schema.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["INVALID_INPUT"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/InvalidInputFailureData"}}},"InvalidInputFailureData":{"additionalProperties":false,"type":"object","properties":{"issues":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ValidationIssue"}}}},"LookupAffiliationBadGatewayError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/LookupAffiliationBadGatewayFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"LookupAffiliationBadGatewayFailure":{"oneOf":[{"$ref":"#/components/schemas/OutcomeUnknownFailure"},{"$ref":"#/components/schemas/CaptchaRejectedFailure"},{"$ref":"#/components/schemas/AdresResponseUnrecognizedFailure"}],"discriminator":{"propertyName":"code","mapping":{"OUTCOME_UNKNOWN":"#/components/schemas/OutcomeUnknownFailure","CAPTCHA_REJECTED":"#/components/schemas/CaptchaRejectedFailure","ADRES_RESPONSE_UNRECOGNIZED":"#/components/schemas/AdresResponseUnrecognizedFailure"}}},"LookupAffiliationInput":{"additionalProperties":false,"type":"object","required":["documentNumber"],"properties":{"documentNumber":{"pattern":"^(?:[0-9]{1,14}|[A-Z0-9]{8,10})$","description":"The identifier accepted by the ADRES form, sent as a string. Preserve leading zeros and any uppercase letters.","type":"string"},"documentType":{"default":"CC","description":"CC ciudadanía, CE extranjería, TI tarjeta de identidad, RC registro civil, CN certificado de nacido vivo, NU número único, MS menor sin identificación. Use the type on the document. Defaults to CC.","anyOf":[{"const":"CC","type":"string"},{"const":"CE","type":"string"},{"const":"TI","type":"string"},{"const":"RC","type":"string"},{"const":"CN","type":"string"},{"const":"NU","type":"string"},{"const":"MS","type":"string"}]},"countryCode":{"description":"ISO country code of the issuing country. Currently Colombia.","const":"CO","type":"string"}}},"LookupAffiliationServiceUnavailableError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/LookupAffiliationServiceUnavailableFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"LookupAffiliationServiceUnavailableFailure":{"oneOf":[{"$ref":"#/components/schemas/UpstreamUnavailableFailure"},{"$ref":"#/components/schemas/LookupUnavailableFailure"},{"$ref":"#/components/schemas/CaptchaUnavailableFailure"},{"$ref":"#/components/schemas/AdresUnavailableFailure"}],"discriminator":{"propertyName":"code","mapping":{"UPSTREAM_UNAVAILABLE":"#/components/schemas/UpstreamUnavailableFailure","LOOKUP_UNAVAILABLE":"#/components/schemas/LookupUnavailableFailure","CAPTCHA_UNAVAILABLE":"#/components/schemas/CaptchaUnavailableFailure","ADRES_UNAVAILABLE":"#/components/schemas/AdresUnavailableFailure"}}},"LookupInProgressError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/LookupInProgressFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"LookupInProgressFailure":{"type":"object","description":"A lookup for this document is in progress.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["LOOKUP_IN_PROGRESS"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"LookupUnavailableFailure":{"type":"object","description":"This lookup is temporarily unavailable.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["LOOKUP_UNAVAILABLE"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"OfficialSisbenClassification":{"anyOf":[{"additionalProperties":false,"type":"object","required":["source","verification","observedAt","registered","group","subgroup"],"properties":{"source":{"const":"DNP-SISBEN-IV","type":"string"},"verification":{"anyOf":[{"const":"source_report","type":"string"},{"const":"last_known","type":"string"}]},"observedAt":{"format":"date-time","type":"string"},"registered":{"const":true,"type":"boolean"},"group":{"pattern":"^[ABCD]$","type":"string"},"subgroup":{"anyOf":[{"pattern":"^(A[1-5]|B[1-7]|C([1-9]|1[0-8])|D([1-9]|1[0-9]|2[01]))$","type":"string"},{"type":"null"}]}}},{"additionalProperties":false,"type":"object","required":["source","verification","observedAt","registered","group","subgroup"],"properties":{"source":{"const":"DNP-SISBEN-IV","type":"string"},"verification":{"anyOf":[{"const":"source_report","type":"string"},{"const":"last_known","type":"string"}]},"observedAt":{"format":"date-time","type":"string"},"registered":{"const":false,"type":"boolean"},"group":{"type":"null"},"subgroup":{"type":"null"}}},{"additionalProperties":false,"type":"object","required":["source","verification","registered","group","subgroup","observedAt"],"properties":{"source":{"const":"DNP-SISBEN-IV","type":"string"},"verification":{"anyOf":[{"const":"unavailable","type":"string"},{"const":"unsupported_document","type":"string"}]},"registered":{"type":"null"},"group":{"type":"null"},"subgroup":{"type":"null"},"observedAt":{"type":"null"}}}]},"OutcomeUnknownFailure":{"type":"object","description":"The operation may have been applied; check its result before repeating it.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["OUTCOME_UNKNOWN"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"RateLimitedError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/RateLimitedFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"RateLimitedFailure":{"type":"object","description":"The request rate limit was exceeded. Try again later.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["RATE_LIMITED"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[true],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"RequestTooLargeError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/RequestTooLargeFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"RequestTooLargeFailure":{"type":"object","description":"The request exceeds the allowed size.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["REQUEST_TOO_LARGE"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"ResponseMetadata":{"type":"object","description":"What every answer carries besides its data or error.","additionalProperties":false,"required":["requestId"],"properties":{"requestId":{"type":"string","description":"Request correlation identifier, also sent as X-Request-Id."}}},"UnauthorizedError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/UnauthorizedFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"UnauthorizedFailure":{"type":"object","description":"A valid access token is required.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"UnsupportedMediaTypeError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/UnsupportedMediaTypeFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"UnsupportedMediaTypeFailure":{"type":"object","description":"The request content type is not supported.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["UNSUPPORTED_MEDIA_TYPE"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[false],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"UpstreamTimeoutError":{"type":"object","description":"A failed answer.","additionalProperties":false,"required":["success","data","error","metadata"],"properties":{"success":{"type":"boolean","enum":[false]},"data":{"const":null},"error":{"$ref":"#/components/schemas/UpstreamTimeoutFailure"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"UpstreamTimeoutFailure":{"type":"object","description":"The upstream service did not respond before its deadline.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["UPSTREAM_TIMEOUT"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[true],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"UpstreamUnavailableFailure":{"type":"object","description":"The upstream service could not complete the request.","additionalProperties":false,"required":["code","message","retryable","data"],"properties":{"code":{"type":"string","enum":["UPSTREAM_UNAVAILABLE"],"description":"The failure code, stable across releases."},"message":{"type":"string","description":"What went wrong, for people; it never contains input values."},"retryable":{"type":"boolean","enum":[true],"description":"Whether repeating the same request may succeed."},"data":{"$ref":"#/components/schemas/Empty"}}},"ValidationIssue":{"additionalProperties":false,"type":"object","required":["path","message"],"properties":{"path":{"maxLength":256,"description":"RFC 6901 JSON Pointer to the refused field; empty for the whole input.","type":"string"},"message":{"maxLength":256,"type":"string"}}}},"headers":{"RequestId":{"description":"Request correlation identifier.","schema":{"type":"string"}},"RetryAfter":{"description":"Seconds before another attempt.","schema":{"type":"integer","minimum":0}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.getarbol.com/authorize","tokenUrl":"https://auth.getarbol.com/oauth/token","scopes":{"adres:affiliations:read":"Read affiliations."}},"clientCredentials":{"tokenUrl":"https://auth.getarbol.com/oauth/token","scopes":{"adres:affiliations:read":"Read affiliations."}}}}}}}