{"components":{"schemas":{"ARSAccountNumberPayoutMethodDetails":{"properties":{"bankAccountNumber":{"type":"string"},"bankAccountNumberType":{"description":"Type of bank account number (CVU or CBU)","enum":["CVU","CBU"],"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_ars_001","type":"string"},"documentNumber":{"type":"string"},"symbol":{"enum":["ARS"],"type":"string"},"type":{"enum":["arsAccountNumber"],"type":"string"}},"required":["type","symbol","bankAccountNumber","bankAccountNumberType","documentNumber","bankId"],"type":"object"},"ARSAccountNumberPayoutMethodResponseDetails":{"properties":{"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****3456","type":"string"},"bankAccountNumberType":{"description":"Type of bank account number (CVU or CBU)","enum":["CVU","CBU"],"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_ars_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****5678","type":"string"},"symbol":{"enum":["ARS"],"type":"string"},"type":{"enum":["arsAccountNumber"],"type":"string"}},"required":["type","symbol","bankAccountNumberType","bankId","bankAccountNumberTruncated","documentNumberTruncated"],"type":"object"},"ARSAliasPayoutMethodDetails":{"properties":{"alias":{"description":"Alias of the bank account","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_ars_001","type":"string"},"documentNumber":{"type":"string"},"symbol":{"enum":["ARS"],"type":"string"},"type":{"enum":["arsAlias"],"type":"string"}},"required":["type","symbol","alias","documentNumber","bankId"],"type":"object"},"ARSAliasPayoutMethodResponseDetails":{"properties":{"aliasTruncated":{"description":"Masked bank account alias (format: ****1234)","example":"****s.mp","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_ars_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****5432","type":"string"},"symbol":{"enum":["ARS"],"type":"string"},"type":{"enum":["arsAlias"],"type":"string"}},"required":["type","symbol","bankId","aliasTruncated","documentNumberTruncated"],"type":"object"},"ARSBankTransferPayinAmount":{"description":"ARS amount in cents.","properties":{"currencySymbol":{"description":"Must be `ARS`.","enum":["ARS"],"example":"ARS","type":"string"},"value":{"description":"Amount in cents (e.g. `\"1230000\"` = 12,300.00 ARS).","example":"1230000","type":"string"}},"required":["currencySymbol","value"],"type":"object"},"ARSBankTransferPayinCreationDetails":{"description":"Create an ARS bank-transfer (CVU) pay-in. The payer must send the exact requested amount from the account matching `accountNumber`.","properties":{"accountNumber":{"description":"The payer's source CBU/CVU. Must match the account the payer sends from.","example":"0000003100010000000001","type":"string"},"amount":{"allOf":[{"$ref":"#/components/schemas/ARSBankTransferPayinAmount"}],"description":"The amount the payer must transfer.","example":{"currencySymbol":"ARS","value":"1230000"}},"expiresInSeconds":{"description":"Seconds until the pay-in expires. Default 300 (5 min). Min 300 (5 min). Max 259200 (3 days).","maximum":259200,"minimum":300,"type":"integer"},"type":{"enum":["ars-bank-transfer"],"type":"string"}},"required":["type","amount","accountNumber"],"type":"object"},"ARSBankTransferPayinInstructions":{"description":"Instructions for an ARS bank-transfer (CVU) pay-in.","properties":{"bankName":{"description":"Name of the bank holding the CVU.","example":"Banco de la Nación Argentina","type":"string"},"cvu":{"description":"The CVU the payer transfers ARS to.","example":"0000003100010000000001","type":"string"},"expiresAt":{"description":"When the pay-in expires.","format":"date-time","type":"string"},"type":{"enum":["ars-bank-transfer"],"type":"string"}},"required":["type","cvu","bankName","expiresAt"],"type":"object"},"ARSBankTransferSenderMetadata":{"properties":{"senderAccountNumber":{"description":"Payer's account number (CVU/CBU), unformatted.","example":"0000003100010000000001","type":"string"},"senderId":{"description":"Payer's tax/document number as reported by the sending bank.","example":"20123456786","type":"string"},"senderIdType":{"description":"The kind of identifier in `senderId` (e.g. `CUIT`, `DNI`).","example":"CUIT","type":"string"},"senderName":{"description":"Payer's full name as reported by the sending bank.","example":"Diego Maradona","type":"string"},"type":{"enum":["ars-bank-transfer"],"type":"string"}},"required":["type"],"type":"object"},"ARSDeveloperFee":{"properties":{"developerFeePercentage":{"description":"Developer fee percentage for ARS payins (0-100)","example":2,"maximum":100,"minimum":0,"type":"number"},"type":{"enum":["ars"],"type":"string"}},"required":["type","developerFeePercentage"],"type":"object"},"ARSPayinRailDetails":{"properties":{"accountNumber":{"description":"Account number for transfers","type":"string"},"bankName":{"description":"The name of the bank","type":"string"},"currency":{"enum":["ARS"],"type":"string"},"payinRail":{"description":"The payment rail type for ARS deposits","enum":["CVU"],"type":"string"},"type":{"enum":["ars"],"type":"string"}},"required":["type","currency","payinRail","accountNumber","bankName"],"type":"object"},"ARSPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/ARSAliasPayoutMethodDetails","title":"ARS Alias"},{"$ref":"#/components/schemas/ARSAccountNumberPayoutMethodDetails","title":"ARS Account Number"}]},"type":{"enum":["ars"],"type":"string"}},"required":["type","details"],"type":"object"},"ARSPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/ARSAliasPayoutMethodResponseDetails","title":"ARS Alias"},{"$ref":"#/components/schemas/ARSAccountNumberPayoutMethodResponseDetails","title":"ARS Account Number"}]},"type":{"enum":["ars"],"type":"string"}},"required":["type","details"],"type":"object"},"Account":{"properties":{"accountDetails":{"allOf":[{"$ref":"#/components/schemas/MuralAccountDetails"}],"description":"The details of the Account. Will only be populated once the status is ACTIVE"},"createdAt":{"format":"date-time","type":"string"},"description":{"description":"The description of the Account","type":"string"},"destinationToken":{"allOf":[{"$ref":"#/components/schemas/TokenWithBlockchain"}],"description":"The default destination token and blockchain for the Account. This is used for payin deposits that are initiated outside of Mural's infrastructure (i.e., not via the Payins API)."},"id":{"description":"The unique identifier for the Account","format":"uuid","type":"string"},"isApiEnabled":{"description":"Whether or not the Account can be managed by the API. Accounts created in the platform will not be enabled unless you grant API access to the Account in the platform.","type":"boolean"},"name":{"description":"The name of the Account","type":"string"},"status":{"description":"The status of the Account. Will start in INITIALIZING and move to ACTIVE once the Account is ready to use.","enum":["INITIALIZING","ACTIVE"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","name","createdAt","updatedAt","isApiEnabled","status","destinationToken"],"type":"object"},"AchPayinAmount":{"properties":{"currencySymbol":{"enum":["USD"],"type":"string"},"value":{"description":"The amount in cents (e.g., \"2500\" represents 25.00).","example":"2500","type":"string"}},"required":["value","currencySymbol"],"type":"object"},"AchPayinRail":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/AchPayinAmount"}],"description":"The amount to simulate. Must be denominated in USD."},"type":{"enum":["ach"],"type":"string"}},"required":["type","amount"],"type":"object"},"AchSenderMetadata":{"properties":{"achRoutingNumber":{"description":"The ACH routing number","type":"string"},"description":{"description":"The description of the transaction","type":"string"},"senderName":{"description":"The name of the sender","type":"string"},"traceNumber":{"description":"The ACH trace number","type":"string"},"type":{"enum":["ach"],"type":"string"}},"required":["type","achRoutingNumber","senderName","traceNumber"],"type":"object"},"AdditionalCounterpartyInformationRequiredBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"AdditionalCounterpartyInformationRequired","type":"string"},"params":{"$ref":"#/components/schemas/AdditionalCounterpartyInformationRequiredBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"AdditionalCounterpartyInformationRequiredBodyParams":{"properties":{"counterpartyId":{"description":"ID of the counterparty that is missing required information.","format":"uuid","type":"string"},"missingFields":{"description":"Names of recipient fields required for this payout method's destination currency that are missing from the counterparty. Populate these on the counterparty (or use an existing counterparty that already has them) and retry.","example":["email"],"items":{"type":"string"},"type":"array"}},"required":["counterpartyId","missingFields"],"type":"object"},"AdditionalRecipientInformationRequiredBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"AdditionalRecipientInformationRequired","type":"string"},"params":{"$ref":"#/components/schemas/AdditionalRecipientInformationRequiredBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"AdditionalRecipientInformationRequiredBodyParams":{"properties":{"failures":{"description":"One entry per payout that failed recipient-information validation, identified by its index in the request body. Each entry carries the missing field names plus the counterparty / payout-method ids when the payout referenced a saved counterparty.","items":{"$ref":"#/components/schemas/RecipientValidationFailure"},"type":"array"}},"required":["failures"],"type":"object"},"ArsCvuSenderMetadata":{"properties":{"accountNumber":{"description":"The sender's account number (CVU)","type":"string"},"bankCode":{"description":"The bank identifier code","type":"string"},"bankName":{"description":"The sender's bank name","type":"string"},"coelsaId":{"description":"The COELSA transaction ID","type":"string"},"documentNumber":{"description":"The sender's document number (CUIL/CUIT)","type":"string"},"documentType":{"description":"The sender's document type","type":"string"},"senderName":{"description":"The sender's name","type":"string"},"sourceReference":{"description":"The source reference from the originating bank","type":"string"},"type":{"enum":["ars_cvu"],"type":"string"}},"required":["type"],"type":"object"},"ArsDetails":{"properties":{"bankAccountNumber":{"type":"string"},"bankAccountNumberType":{"enum":["CVU","CBU","ALIAS"],"type":"string"},"documentNumber":{"type":"string"},"symbol":{"enum":["ARS"],"type":"string"},"type":{"enum":["ars"],"type":"string"}},"required":["type","symbol","bankAccountNumber","documentNumber","bankAccountNumberType"],"type":"object"},"AssociatedPersonAttestationRequirement":{"properties":{"attestationType":{"description":"Associated person attestation type required before submitting the compliance review.","enum":["associatedPersonPersonalInfo","associatedPersonContactInfo","associatedPersonResidentialAddress","associatedPersonTaxInfo","associatedPersonIdentityDocument","associatedPersonProofOfAddress","associatedPersonEeaInfo","associatedPersonProofOfSignatoryAuthority"],"type":"string"}},"required":["attestationType"],"type":"object"},"AssociatedPersonAttestationResponse":{"properties":{"attestationType":{"description":"Which associated person attestation was stored.","enum":["associatedPersonPersonalInfo","associatedPersonContactInfo","associatedPersonResidentialAddress","associatedPersonTaxInfo","associatedPersonIdentityDocument","associatedPersonProofOfAddress","associatedPersonEeaInfo","associatedPersonProofOfSignatoryAuthority"],"type":"string"},"createdAt":{"description":"ISO 8601 timestamp when the attestation was stored.","example":"2026-02-24T12:00:00.000Z","type":"string"},"id":{"description":"Unique attestation ID","format":"uuid","type":"string"},"validationStatus":{"description":"Validations lifecycle state for this attestation.","discriminator":{"mapping":{"approved":"#/components/schemas/AttestationValidationStatusApproved","failed":"#/components/schemas/AttestationValidationStatusFailed","pending":"#/components/schemas/AttestationValidationStatusPending"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AttestationValidationStatusPending","title":"Pending"},{"$ref":"#/components/schemas/AttestationValidationStatusApproved","title":"Approved"},{"$ref":"#/components/schemas/AttestationValidationStatusFailed","title":"Failed"}]}},"required":["id","attestationType","createdAt","validationStatus"],"type":"object"},"AssociatedPersonAttestationSummary":{"properties":{"attestationType":{"description":"Which associated person attestation this summary refers to.","enum":["associatedPersonPersonalInfo","associatedPersonContactInfo","associatedPersonResidentialAddress","associatedPersonTaxInfo","associatedPersonIdentityDocument","associatedPersonProofOfAddress","associatedPersonEeaInfo","associatedPersonProofOfSignatoryAuthority"],"type":"string"},"id":{"description":"Unique attestation ID","format":"uuid","type":"string"},"validationStatus":{"description":"Validations lifecycle state for this attestation.","discriminator":{"mapping":{"approved":"#/components/schemas/AttestationValidationStatusApproved","failed":"#/components/schemas/AttestationValidationStatusFailed","pending":"#/components/schemas/AttestationValidationStatusPending"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AttestationValidationStatusPending","title":"Pending"},{"$ref":"#/components/schemas/AttestationValidationStatusApproved","title":"Approved"},{"$ref":"#/components/schemas/AttestationValidationStatusFailed","title":"Failed"}]}},"required":["id","attestationType","validationStatus"],"type":"object"},"AssociatedPersonContactInfoAttestation":{"properties":{"type":{"enum":["associatedPersonContactInfo"],"type":"string","x-order":1},"email":{"description":"Associated person's email address","example":"jane.doe@example.com","type":"string","x-order":2},"phoneNumber":{"description":"Associated person's phone number, including country code (e.g. +14155551234)","example":"+14155551234","type":"string","x-order":3}},"required":["type","email","phoneNumber"],"type":"object"},"AssociatedPersonEEAInfoAttestation":{"properties":{"type":{"enum":["associatedPersonEeaInfo"],"type":"string","x-order":1},"isDirector":{"description":"Whether the associated person is a director of the business. Non-director authorized signers must provide proof of signatory authority.","example":true,"type":"boolean","x-order":2},"placeOfBirthCountry":{"description":"Country of birth (ISO 3166-1 alpha-2 country code).","example":"FR","type":"string","x-order":3},"placeOfBirthCity":{"description":"City of birth.","example":"Paris","type":"string","x-order":4}},"required":["type","isDirector","placeOfBirthCountry","placeOfBirthCity"],"type":"object"},"AssociatedPersonIdentityDocumentAttestation":{"properties":{"type":{"enum":["associatedPersonIdentityDocument"],"type":"string","x-order":1},"governmentId":{"description":"Government ID document.","discriminator":{"mapping":{"citizenshipCertificate":"#/components/schemas/CitizenshipCertificateIdentityDocument","cnh":"#/components/schemas/CnhIdentityDocument","consularId":"#/components/schemas/ConsularIdIdentityDocument","driverLicense":"#/components/schemas/DriverLicenseIdentityDocument","foreignId":"#/components/schemas/ForeignIdIdentityDocument","healthInsuranceCard":"#/components/schemas/HealthInsuranceCardIdentityDocument","internalPassport":"#/components/schemas/InternalPassportIdentityDocument","keypassId":"#/components/schemas/KeypassIdIdentityDocument","longTermPass":"#/components/schemas/LongTermPassIdentityDocument","municipalId":"#/components/schemas/MunicipalIdIdentityDocument","myNumberCard":"#/components/schemas/MyNumberCardIdentityDocument","nationalId":"#/components/schemas/NationalIdIdentityDocument","nbiClearance":"#/components/schemas/NbiClearanceIdentityDocument","ofwId":"#/components/schemas/OfwIdIdentityDocument","panCard":"#/components/schemas/PanCardIdentityDocument","passport":"#/components/schemas/PassportIdentityDocument","passportCard":"#/components/schemas/PassportCardIdentityDocument","permanentResidenceCard":"#/components/schemas/PermanentResidenceCardIdentityDocument","postalId":"#/components/schemas/PostalIdIdentityDocument","residencePermit":"#/components/schemas/ResidencePermitIdentityDocument","sssId":"#/components/schemas/SssIdIdentityDocument","stateId":"#/components/schemas/StateIdIdentityDocument","travelDocument":"#/components/schemas/TravelDocumentIdentityDocument","tribalId":"#/components/schemas/TribalIdIdentityDocument","umid":"#/components/schemas/UmidIdentityDocument","visa":"#/components/schemas/VisaIdentityDocument","voterId":"#/components/schemas/VoterIdIdentityDocument","workPermit":"#/components/schemas/WorkPermitIdentityDocument"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PassportIdentityDocument","title":"Passport"},{"$ref":"#/components/schemas/DriverLicenseIdentityDocument","title":"Driver's License"},{"$ref":"#/components/schemas/CnhIdentityDocument","title":"CNH (Brazilian Driver's License)"},{"$ref":"#/components/schemas/NationalIdIdentityDocument","title":"National ID"},{"$ref":"#/components/schemas/StateIdIdentityDocument","title":"State ID"},{"$ref":"#/components/schemas/PassportCardIdentityDocument","title":"Passport Card"},{"$ref":"#/components/schemas/PermanentResidenceCardIdentityDocument","title":"Permanent Residence Card"},{"$ref":"#/components/schemas/VisaIdentityDocument","title":"Visa"},{"$ref":"#/components/schemas/ResidencePermitIdentityDocument","title":"Residence Permit"},{"$ref":"#/components/schemas/CitizenshipCertificateIdentityDocument","title":"Citizenship Certificate"},{"$ref":"#/components/schemas/ConsularIdIdentityDocument","title":"Consular ID"},{"$ref":"#/components/schemas/ForeignIdIdentityDocument","title":"Foreign ID"},{"$ref":"#/components/schemas/HealthInsuranceCardIdentityDocument","title":"Health Insurance Card"},{"$ref":"#/components/schemas/InternalPassportIdentityDocument","title":"Internal Passport"},{"$ref":"#/components/schemas/KeypassIdIdentityDocument","title":"Keypass ID"},{"$ref":"#/components/schemas/LongTermPassIdentityDocument","title":"Long Term Pass"},{"$ref":"#/components/schemas/MunicipalIdIdentityDocument","title":"Municipal ID"},{"$ref":"#/components/schemas/MyNumberCardIdentityDocument","title":"My Number Card"},{"$ref":"#/components/schemas/NbiClearanceIdentityDocument","title":"NBI Clearance"},{"$ref":"#/components/schemas/OfwIdIdentityDocument","title":"OFW ID"},{"$ref":"#/components/schemas/PanCardIdentityDocument","title":"PAN Card"},{"$ref":"#/components/schemas/PostalIdIdentityDocument","title":"Postal ID"},{"$ref":"#/components/schemas/SssIdIdentityDocument","title":"SSS ID"},{"$ref":"#/components/schemas/TravelDocumentIdentityDocument","title":"Travel Document"},{"$ref":"#/components/schemas/TribalIdIdentityDocument","title":"Tribal ID"},{"$ref":"#/components/schemas/UmidIdentityDocument","title":"UMID"},{"$ref":"#/components/schemas/VoterIdIdentityDocument","title":"Voter ID"},{"$ref":"#/components/schemas/WorkPermitIdentityDocument","title":"Work Permit"}],"x-order":2}},"required":["type","governmentId"],"type":"object"},"AssociatedPersonPersonalInfoAttestation":{"properties":{"type":{"enum":["associatedPersonPersonalInfo"],"type":"string","x-order":1},"name":{"allOf":[{"$ref":"#/components/schemas/IndividualName"}],"description":"Associated person's name","example":{"firstName":"Jane","lastName":"Doe","middleName":"Marie"},"x-order":2},"birthDate":{"description":"Associated person's date of birth (YYYY-MM-DD)","example":"1985-06-15","type":"string","x-order":3},"nationality":{"description":"Associated person's nationality (ISO 3166-1 alpha-2 country code)","example":"US","type":"string","x-order":4},"isPoliticallyExposed":{"description":"Whether the associated person is a politically exposed person (PEP). When omitted, no PEP status is declared (treated as undisclosed, not `false`).","example":false,"type":"boolean","x-order":5},"jobTitle":{"description":"Associated person's job title or role within the business (2-200 chars)","example":"Chief Executive Officer","type":"string","x-order":6},"ownershipPercentage":{"description":"Ownership percentage of the underlying business held by this associated person.","example":25,"maximum":100,"minimum":0,"type":"number","x-order":7}},"required":["type","name","birthDate","nationality","jobTitle","ownershipPercentage"],"type":"object"},"AssociatedPersonProofOfAddressAttestation":{"properties":{"type":{"enum":["associatedPersonProofOfAddress"],"type":"string","x-order":1},"proofOfAddressDocuments":{"description":"List of proof-of-address documents","items":{"$ref":"#/components/schemas/ProofOfAddressDocumentReference"},"type":"array","x-order":2}},"required":["type","proofOfAddressDocuments"],"type":"object"},"AssociatedPersonProofOfSignatoryAuthorityAttestation":{"properties":{"type":{"enum":["associatedPersonProofOfSignatoryAuthority"],"type":"string","x-order":1},"signatoryAuthorityDocuments":{"description":"List of proof-of-signatory-authority documents","items":{"$ref":"#/components/schemas/SignatoryAuthorityDocumentReference"},"type":"array","x-order":2}},"required":["type","signatoryAuthorityDocuments"],"type":"object"},"AssociatedPersonResidentialAddressAttestation":{"properties":{"type":{"enum":["associatedPersonResidentialAddress"],"type":"string","x-order":1},"address":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Associated person's residential address","x-order":2}},"required":["type","address"],"type":"object"},"AssociatedPersonResource":{"properties":{"associatedPersonId":{"description":"Associated person UUID.","format":"uuid","type":"string","x-order":1},"relationships":{"description":"The relationship(s) of this associated person to the business. A person can be both a beneficial owner and a control person.","example":["BENEFICIAL_OWNER"],"items":{"enum":["BENEFICIAL_OWNER","CONTROL_PERSON"],"type":"string"},"type":"array","x-order":2},"createdAt":{"description":"ISO 8601 timestamp when the associated person was created.","example":"2026-02-24T12:00:00.000Z","type":"string","x-order":3},"updatedAt":{"description":"ISO 8601 timestamp when the associated person was last updated.","example":"2026-02-24T12:00:00.000Z","type":"string","x-order":4},"requiredAttestations":{"description":"Attestation types this associated person still needs before the review can be submitted.","items":{"$ref":"#/components/schemas/AssociatedPersonAttestationRequirement"},"type":"array","x-order":5},"uploadedAttestations":{"description":"Attestations uploaded for this associated person.","example":[],"items":{"$ref":"#/components/schemas/AssociatedPersonAttestationSummary"},"type":"array","x-order":6}},"required":["associatedPersonId","relationships","createdAt","updatedAt","uploadedAttestations"],"type":"object"},"AssociatedPersonTaxInfoAttestation":{"properties":{"type":{"enum":["associatedPersonTaxInfo"],"type":"string","x-order":1},"taxIdentificationNumber":{"description":"Tax identification number.","example":"123-45-6789","type":"string","x-order":2},"taxIdentificationNumberType":{"description":"Type of tax identification number","enum":["SSN","ITIN","CPF","CURP","CUIL","NINO","INE","RFC","NIF","STEUER_ID","TCKN","TIN","PAN","ADOAZ","AHV","AOM","BSN","BVN","CDI","CNP","CPR","EGN","EMIRATES_ID","EMSO","FIN","FN","FODSELSNR","HETU","HKID","IDNP","IIN","IK","ITR","JMBG","MN","NIN","NRIC","NRN","PERSONNUMMER","PESEL","PIN","PINFL","PPSN","RICN","RNOKPP","RODNE_CISLO","RP","RRN","SI","SIN","SPI","TFN","UCN","UTR","BIR","BIN","BP","CF","CN","CRIB","CUI","CUIT","ID","ID_BROJ","IDNO","IF","INN","IRD","MATRICULE","MST","NIT","NPWP","NRT","NTN","OIB","PIB","RC","RIF","RN","RTN","RUC","RUT","TRN","UNP","USC","VAT","VOEN"],"example":"SSN","type":"string","x-order":3}},"required":["type","taxIdentificationNumber","taxIdentificationNumberType"],"type":"object"},"AttestationRequirement":{"properties":{"attestationType":{"description":"Attestation type required to submit the compliance review.","enum":["individualPersonalInfoLight","individualPersonalInfo","individualContactInfo","individualResidentialAddress","individualIdentityDocument","individualFinancialInfo","individualTaxInfo","individualEeaInfo","individualProofOfAddress","individualSourceOfFunds","individualSelfiePhoto","businessIdentification","businessTaxInfo","businessAddress","businessContactInfo","businessDetails","businessOperations","businessFinancialInfo","businessFormationDocuments","businessUboOwnershipDocuments","businessProofOfAddressDocuments","businessFlowOfFundsDocument","businessAssociatedPersons"],"type":"string"}},"required":["attestationType"],"type":"object"},"AttestationResponse":{"properties":{"attestationType":{"description":"Which attestation payload this row stores.","enum":["individualPersonalInfoLight","individualPersonalInfo","individualContactInfo","individualResidentialAddress","individualIdentityDocument","individualFinancialInfo","individualTaxInfo","individualEeaInfo","individualProofOfAddress","individualSourceOfFunds","individualSelfiePhoto","businessIdentification","businessTaxInfo","businessAddress","businessContactInfo","businessDetails","businessOperations","businessFinancialInfo","businessFormationDocuments","businessUboOwnershipDocuments","businessProofOfAddressDocuments","businessFlowOfFundsDocument","businessAssociatedPersons"],"type":"string"},"createdAt":{"description":"ISO 8601 timestamp when the attestation was stored.","example":"2026-02-24T12:00:00.000Z","format":"date-time","type":"string"},"id":{"description":"Unique attestation ID","format":"uuid","type":"string"},"validationStatus":{"description":"Validations lifecycle state for this attestation.","discriminator":{"mapping":{"approved":"#/components/schemas/AttestationValidationStatusApproved","failed":"#/components/schemas/AttestationValidationStatusFailed","pending":"#/components/schemas/AttestationValidationStatusPending"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AttestationValidationStatusPending","title":"Pending"},{"$ref":"#/components/schemas/AttestationValidationStatusApproved","title":"Approved"},{"$ref":"#/components/schemas/AttestationValidationStatusFailed","title":"Failed"}]}},"required":["id","attestationType","createdAt","validationStatus"],"type":"object"},"AttestationSummary":{"properties":{"attestationType":{"description":"Which attestation this summary refers to.","enum":["individualPersonalInfoLight","individualPersonalInfo","individualContactInfo","individualResidentialAddress","individualIdentityDocument","individualFinancialInfo","individualTaxInfo","individualEeaInfo","individualProofOfAddress","individualSourceOfFunds","individualSelfiePhoto","businessIdentification","businessTaxInfo","businessAddress","businessContactInfo","businessDetails","businessOperations","businessFinancialInfo","businessFormationDocuments","businessUboOwnershipDocuments","businessProofOfAddressDocuments","businessFlowOfFundsDocument","businessAssociatedPersons"],"type":"string"},"id":{"description":"Unique attestation ID","format":"uuid","type":"string"},"validationStatus":{"description":"Validations lifecycle state for this attestation.","discriminator":{"mapping":{"approved":"#/components/schemas/AttestationValidationStatusApproved","failed":"#/components/schemas/AttestationValidationStatusFailed","pending":"#/components/schemas/AttestationValidationStatusPending"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AttestationValidationStatusPending","title":"Pending"},{"$ref":"#/components/schemas/AttestationValidationStatusApproved","title":"Approved"},{"$ref":"#/components/schemas/AttestationValidationStatusFailed","title":"Failed"}]}},"required":["id","attestationType","validationStatus"],"type":"object"},"AttestationSummaryParam":{"properties":{"id":{"description":"Attestation ID","format":"uuid","type":"string"},"name":{"description":"Attestation name","type":"string"},"type":{"description":"Attestation type","type":"string"}},"required":["type","id","name"],"type":"object"},"AttestationValidationFailure":{"description":"","properties":{"failureCode":{"description":"A reason the validation failed.","enum":["INCORRECT_DOCUMENT","POOR_QUALITY","MISSING_INFORMATION","INCONSISTENT_DATA","EXPIRED_DOCUMENT","OTHER"],"example":"INCORRECT_DOCUMENT","type":"string"},"severity":{"description":"`BLOCKING` must be addressed before submit can succeed; `WARNING` can be resolved by acknowledging warnings at submit-time.","enum":["BLOCKING","WARNING"],"example":"BLOCKING","type":"string"}},"required":["failureCode","severity"],"type":"object"},"AttestationValidationStatusApproved":{"description":"Attestation passed validations.","properties":{"type":{"enum":["approved"],"type":"string"}},"required":["type"],"type":"object"},"AttestationValidationStatusFailed":{"description":"Attestation failed validations.","properties":{"failures":{"description":"Information about the failed validations for this attestation.","items":{"$ref":"#/components/schemas/AttestationValidationFailure"},"type":"array"},"type":{"enum":["failed"],"type":"string"}},"required":["type","failures"],"type":"object"},"AttestationValidationStatusPending":{"description":"Validations in progress.","properties":{"type":{"enum":["pending"],"type":"string"}},"required":["type"],"type":"object"},"AttestationValidationsRejectedErrorBodyParams":{"properties":{"attestations":{"description":"Latest attestations per type with validation failures. Each item lists the failures by severity — `BLOCKING` failures require re-upload, `WARNING` failures can be acknowledged at submit-time.","items":{"$ref":"#/components/schemas/RejectedComplianceAttestation"},"type":"array"},"complianceReviewId":{"description":"The compliance review that was submitted","format":"uuid","type":"string"},"organizationId":{"description":"Organization ID","format":"uuid","type":"string"}},"required":["complianceReviewId","organizationId","attestations"],"type":"object"},"AttestationValidationsRejectedExceptionBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"AttestationValidationsRejectedException","type":"string"},"params":{"$ref":"#/components/schemas/AttestationValidationsRejectedErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"AutoOnrampSettlementStrategy":{"description":"Funds were automatically converted to the destination token on settlement.","properties":{"type":{"enum":["autoOnramp"],"type":"string"}},"required":["type"],"type":"object"},"AwaitingKYC":{"description":"Indicates the required KYC verification is in progress","properties":{"details":{"type":"string"},"type":{"enum":["awaitingKYC"],"type":"string"}},"required":["type","details"],"type":"object"},"BOBDomesticPayoutMethodDetails":{"properties":{"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_bob_001","type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","RUC_NIT","RESIDENT_ID"],"type":"string"},"symbol":{"enum":["BOB"],"type":"string"},"type":{"enum":["bobDomestic"],"type":"string"}},"required":["type","symbol","bankAccountNumber","documentNumber","documentType","bankId"],"type":"object"},"BOBDomesticPayoutMethodResponseDetails":{"properties":{"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****7890","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_bob_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****4567","type":"string"},"documentType":{"enum":["NATIONAL_ID","RUC_NIT","RESIDENT_ID"],"type":"string"},"symbol":{"enum":["BOB"],"type":"string"},"type":{"enum":["bobDomestic"],"type":"string"}},"required":["type","symbol","documentType","bankId","bankAccountNumberTruncated","documentNumberTruncated"],"type":"object"},"BOBPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/BOBDomesticPayoutMethodDetails","title":"BOB Domestic"}]},"type":{"enum":["bob"],"type":"string"}},"required":["type","details"],"type":"object"},"BOBPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/BOBDomesticPayoutMethodResponseDetails","title":"BOB Domestic"}]},"type":{"enum":["bob"],"type":"string"}},"required":["type","details"],"type":"object"},"BRLDeveloperFee":{"properties":{"developerFeePercentage":{"description":"Developer fee percentage for BRL payins (0-100)","example":1.5,"maximum":100,"minimum":0,"type":"number"},"type":{"enum":["brl"],"type":"string"}},"required":["type","developerFeePercentage"],"type":"object"},"BRLPayinRailDetails":{"properties":{"bankName":{"description":"The name of the bank","type":"string"},"currency":{"enum":["BRL"],"type":"string"},"payinRail":{"description":"The payment rail type for BRL deposits","enum":["PIX"],"type":"string"},"pixBRcode":{"description":"PIX BR code for instant payments","type":"string"},"type":{"enum":["brl"],"type":"string"}},"required":["type","currency","payinRail","pixBRcode","bankName"],"type":"object"},"BRLPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/BRLPixPhonePayoutMethodDetails","title":"BRL PIX Phone"},{"$ref":"#/components/schemas/BRLPixEmailPayoutMethodDetails","title":"BRL PIX Email"},{"$ref":"#/components/schemas/BRLPixDocumentPayoutMethodDetails","title":"BRL PIX Document"},{"$ref":"#/components/schemas/BRLPixBankAccountPayoutMethodDetails","title":"BRL PIX Bank Account"},{"$ref":"#/components/schemas/BRLWirePayoutMethodDetails","title":"BRL Wire"}]},"type":{"enum":["brl"],"type":"string"}},"required":["type","details"],"type":"object"},"BRLPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/BRLPixPhonePayoutMethodResponseDetails","title":"BRL PIX Phone"},{"$ref":"#/components/schemas/BRLPixEmailPayoutMethodResponseDetails","title":"BRL PIX Email"},{"$ref":"#/components/schemas/BRLPixDocumentPayoutMethodResponseDetails","title":"BRL PIX Document"},{"$ref":"#/components/schemas/BRLPixBankAccountPayoutMethodResponseDetails","title":"BRL PIX Bank Account"},{"$ref":"#/components/schemas/BRLWirePayoutMethodResponseDetails","title":"BRL Wire"}]},"type":{"enum":["brl"],"type":"string"}},"required":["type","details"],"type":"object"},"BRLPixBankAccountPayoutMethodDetails":{"properties":{"bankAccountNumber":{"description":"PIX bank account key","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumber":{"type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["pixBankAccount"],"type":"string"}},"required":["type","symbol","bankAccountNumber","documentNumber","bankId"],"type":"object"},"BRLPixBankAccountPayoutMethodResponseDetails":{"properties":{"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****4444","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****4322","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["pixBankAccount"],"type":"string"}},"required":["type","symbol","bankId","bankAccountNumberTruncated","documentNumberTruncated"],"type":"object"},"BRLPixDocumentPayoutMethodDetails":{"properties":{"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumber":{"description":"PIX document key (CPF or CNPJ)","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["pixDocument"],"type":"string"}},"required":["type","symbol","documentNumber","bankId"],"type":"object"},"BRLPixDocumentPayoutMethodResponseDetails":{"properties":{"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****3344","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["pixDocument"],"type":"string"}},"required":["type","symbol","bankId","documentNumberTruncated"],"type":"object"},"BRLPixEmailPayoutMethodDetails":{"properties":{"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumber":{"type":"string"},"email":{"description":"PIX email key","format":"email","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["pixEmail"],"type":"string"}},"required":["type","symbol","email","documentNumber","bankId"],"type":"object"},"BRLPixEmailPayoutMethodResponseDetails":{"properties":{"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****8900","type":"string"},"emailTruncated":{"description":"Masked email (format: ****1234)","example":"****.com","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["pixEmail"],"type":"string"}},"required":["type","symbol","bankId","emailTruncated","documentNumberTruncated"],"type":"object"},"BRLPixPayinAmount":{"description":"BRL amount in cents.","properties":{"currencySymbol":{"description":"Must be `BRL`.","enum":["BRL"],"example":"BRL","type":"string"},"value":{"description":"Amount in cents (e.g. `\"12345\"` = 123.45 BRL).","example":"12345","type":"string"}},"required":["currencySymbol","value"],"type":"object"},"BRLPixPayinCreationDetails":{"description":"Create a BRL Pix pay-in. The payer must send the exact requested amount; mismatched payments are declined.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/BRLPixPayinAmount"}],"description":"The amount the payer must send.","example":{"currencySymbol":"BRL","value":"12345"}},"expiresInSeconds":{"description":"Seconds until the pay-in expires. Default 86400 (1 day). Min 300 (5 min). Max 259200 (3 days).","maximum":259200,"minimum":300,"type":"integer"},"type":{"enum":["brl-pix"],"type":"string"}},"required":["type","amount"],"type":"object"},"BRLPixPayinInstructions":{"description":"Pay-in instructions for a BRL Pix payment.","properties":{"brCode":{"description":"BR Code (Pix copy-paste string) the payer pastes in their banking app.","type":"string"},"expiresAt":{"description":"When the pay-in expires.","format":"date-time","type":"string"},"type":{"enum":["brl-pix"],"type":"string"}},"required":["type","brCode","expiresAt"],"type":"object"},"BRLPixPhonePayoutMethodDetails":{"properties":{"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumber":{"type":"string"},"phoneNumber":{"description":"PIX phone number key","format":"phone","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["pixPhone"],"type":"string"}},"required":["type","symbol","phoneNumber","documentNumber","bankId"],"type":"object"},"BRLPixPhonePayoutMethodResponseDetails":{"properties":{"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****8900","type":"string"},"phoneNumberTruncated":{"description":"Masked phone number (format: ****1234)","example":"****9999","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["pixPhone"],"type":"string"}},"required":["type","symbol","bankId","phoneNumberTruncated","documentNumberTruncated"],"type":"object"},"BRLWirePayoutMethodDetails":{"properties":{"accountNumber":{"type":"string"},"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankBranch":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumber":{"type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["wire"],"type":"string"}},"required":["type","symbol","bankBranch","accountType","accountNumber","documentNumber","bankId"],"type":"object"},"BRLWirePayoutMethodResponseDetails":{"properties":{"accountNumberTruncated":{"description":"Masked account number (format: ****1234)","example":"****45-6","type":"string"},"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankBranchTruncated":{"description":"Masked bank branch (format: ****1234)","example":"****0001","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_brl_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****8899","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["wire"],"type":"string"}},"required":["type","symbol","accountType","bankId","accountNumberTruncated","bankBranchTruncated","documentNumberTruncated"],"type":"object"},"BankDetails":{"properties":{"bankNames":{"description":"List of the names of the banks for this fiat currency and rail. If list is empty, it means that the exact bank name is not required to process the payout.","items":{"type":"string"},"type":"array"}},"required":["bankNames"],"type":"object"},"BankInfo":{"properties":{"id":{"description":"Unique bank identifier","example":"bank_usd_peru_002","type":"string"},"name":{"description":"Display name of the bank","example":"Banco de Crédito del Perú","type":"string"}},"required":["id","name"],"type":"object"},"BankSelectionNotRequired":{"properties":{"type":{"enum":["notRequired"],"type":"string"}},"required":["type"],"type":"object"},"BankSelectionRequired":{"properties":{"banks":{"description":"Available banks for this payout method type. Always non-empty when type is required.","items":{"$ref":"#/components/schemas/BankInfo"},"type":"array"},"type":{"enum":["required"],"type":"string"}},"required":["type","banks"],"type":"object"},"BanksInfo":{"properties":{"bankDetails":{"additionalProperties":false,"anyOf":[{"properties":{"ars":{"$ref":"#/components/schemas/BankDetails"},"bob":{"$ref":"#/components/schemas/BankDetails"},"brl":{"$ref":"#/components/schemas/BankDetails"},"clp":{"$ref":"#/components/schemas/BankDetails"},"cop":{"$ref":"#/components/schemas/BankDetails"},"cop-bre-b":{"$ref":"#/components/schemas/BankDetails"},"cop-cobre-balance":{"$ref":"#/components/schemas/BankDetails"},"crc":{"$ref":"#/components/schemas/BankDetails"},"eur":{"$ref":"#/components/schemas/BankDetails"},"mxn":{"$ref":"#/components/schemas/BankDetails"},"pen":{"$ref":"#/components/schemas/BankDetails"},"usd":{"$ref":"#/components/schemas/BankDetails"},"usd-china":{"$ref":"#/components/schemas/BankDetails"},"usd-hong-kong":{"$ref":"#/components/schemas/BankDetails"},"usd-panama":{"$ref":"#/components/schemas/BankDetails"},"usd-peru":{"$ref":"#/components/schemas/BankDetails"},"zar":{"$ref":"#/components/schemas/BankDetails"}},"type":"object"}],"description":"Map of currency and rail codes to bank details. There will be one entry per currency-and-rail code provided in the request"}},"required":["bankDetails"],"type":"object"},"BlockchainAmount":{"properties":{"type":{"enum":["blockchain"],"type":"string","x-order":1},"tokenSymbol":{"description":"The token symbol.","enum":["USDC","USDT"],"type":"string","x-order":2},"exponent":{"description":"The number of decimal places used by the smallest unit of the token.","example":6,"type":"number","x-order":3},"value":{"description":"The token amount in its smallest unit, as a string to preserve precision.","example":"2500000","type":"string","x-order":4},"blockchain":{"description":"The blockchain network on which the token lives.","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA"],"type":"string","x-order":5}},"required":["type","tokenSymbol","exponent","value","blockchain"],"type":"object"},"BlockchainDepositMetadata":{"properties":{"blockchain":{"description":"The blockchain type","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA"],"type":"string"},"senderAddress":{"example":"0x0000000000000000000000000000000000000000","format":"address","type":"string"},"type":{"enum":["blockchain"],"type":"string"}},"required":["type","senderAddress","blockchain"],"type":"object"},"BlockchainDepositPayinRailDetails":{"properties":{"depositToken":{"oneOf":[{"$ref":"#/components/schemas/USDTTRONDepositToken","title":"USDT (TRON)"},{"$ref":"#/components/schemas/USDCSOLANADepositToken","title":"USDC (Solana)"}]},"destinationAddress":{"description":"The destination address for the deposit.","type":"string"},"senderAddress":{"description":"The sender address for the deposit. If this is defined, the deposits MUST be made to from this address.","type":"string"},"type":{"enum":["blockchainDeposit"],"type":"string"}},"required":["type","depositToken","destinationAddress"],"type":"object"},"BlockchainPayout":{"properties":{"blockchain":{"description":"The destination blockchain. SOLANA is returned only for USD payouts.","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA","SOLANA"],"type":"string"},"destinationAmount":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The token and amount the recipient receives in their wallet."},"status":{"description":"The status of the blockchain payout. The initial status is AWAITING_EXECUTION, and the status will change to PENDING. EXECUTED, FAILED, and CANCELED are terminal statuses. EXECUTED indicates the blockchain transaction associated with the transfer has been executed.","enum":["AWAITING_EXECUTION","PENDING","EXECUTED","FAILED","CANCELED"],"type":"string"},"token":{"description":"The destination token the recipient will receive.","enum":["USDC","USDT"],"type":"string"},"transactionHash":{"description":"On-chain hash for this recipient's settlement. Present for USD payouts to external wallets (populated once settlement completes); absent for USDC payouts — read the top-level `transactionHash` on the payout request in that case.","nullable":true,"type":"string"},"type":{"enum":["blockchain"],"type":"string"},"walletAddress":{"description":"The destination wallet address. EVM (0x-prefixed hex) or Solana (base58-encoded 32-byte pubkey), matching the blockchain value.","type":"string"}},"required":["type","walletAddress","blockchain","token","status","destinationAmount"],"type":"object"},"BlockchainPayoutDetails":{"properties":{"type":{"enum":["blockchain"],"type":"string"},"walletDetails":{"$ref":"#/components/schemas/WalletDetailsInput"}},"required":["type","walletDetails"],"type":"object"},"BlockchainPayoutMethodDetails":{"properties":{"blockchain":{"description":"The blockchain network. SOLANA is accepted only for USD payouts.","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA","SOLANA"],"type":"string"},"type":{"enum":["blockchainWallet"],"type":"string"},"walletAddress":{"description":"The wallet address for blockchain payouts. EVM (0x-prefixed hex) or Solana (base58-encoded 32-byte pubkey), matching the blockchain value.","type":"string"}},"required":["type","walletAddress","blockchain"],"type":"object"},"BlockchainPayoutMethodInfo":{"properties":{"details":{"$ref":"#/components/schemas/BlockchainPayoutMethodResponseDetails"},"type":{"enum":["blockchainWallet"],"type":"string"}},"required":["type","details"],"type":"object"},"BlockchainPayoutMethodResponseDetails":{"properties":{"blockchain":{"description":"The blockchain network. SOLANA is only returned for wallets registered on the USD payout path.","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA","SOLANA"],"type":"string"},"walletAddress":{"description":"The wallet address for blockchain payouts","type":"string"}},"required":["walletAddress","blockchain"],"type":"object"},"BlockchainSenderMetadata":{"description":"Sender metadata for externally-sent blockchain deposits from an allowlisted sender address. Only populated for allowlisted inbound transfers — unsolicited transfers to the wallet address are reflected in the account balance but do not produce a Payin record.","properties":{"blockchain":{"description":"The blockchain network the inbound transfer was received on.","enum":["TRON","SOLANA"],"type":"string"},"senderAddress":{"description":"The on-chain address the funds were sent from.","type":"string"},"transactionHash":{"description":"The on-chain transaction signature/hash of the inbound transfer (e.g. base58 for Solana, hex for Tron). Use this to reconcile the Payin against the source-chain explorer.","type":"string"},"type":{"enum":["blockchain"],"type":"string"}},"required":["type","senderAddress","blockchain","transactionHash"],"type":"object"},"BlockchainSettlementDetails":{"description":"Funds settle via an on-chain transfer to the destination account's wallet.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/BlockchainAmount"}],"description":"The expected (pre-settlement) or actual (post-settlement) token amount delivered to the account's wallet."},"transactionHash":{"description":"The on-chain transaction hash of the settlement transfer.","type":"string"},"type":{"enum":["blockchain"],"type":"string"}},"required":["type","amount"],"type":"object"},"BobDetails":{"properties":{"bankAccountNumber":{"type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["BOB"],"type":"string"},"type":{"enum":["bob"],"type":"string"}},"required":["type","symbol","bankAccountNumber","documentNumber","documentType"],"type":"object"},"BreBValidationFailure":{"properties":{"type":{"enum":["failure"],"type":"string"}},"required":["type"],"type":"object"},"BreBValidationSuccess":{"properties":{"holderIdNumber":{"description":"Identification number of the key holder","example":"123456789","type":"string"},"holderName":{"description":"Name of the key holder","example":"Juan Pérez","type":"string"},"type":{"enum":["success"],"type":"string"}},"required":["type","holderName","holderIdNumber"],"type":"object"},"BrlDetails":{"description":"Deprecated in favor of the BRL Payment method via the payment method API","properties":{"bankAccountNumber":{"description":"Bank account number (EVP key for PIX BANK_ACCOUNT type). Required when pixAccountType is BANK_ACCOUNT or for wire transfers.","type":"string"},"branchCode":{"description":"Branch code. Required for wire transfers (when pixAccountType is not provided).","type":"string"},"documentNumber":{"type":"string"},"pixAccountType":{"description":"The PIX account type. If not provided, the payout will be processed as a wire transfer.","enum":["PHONE","EMAIL","DOCUMENT","BANK_ACCOUNT"],"type":"string"},"pixEmail":{"description":"PIX email key. Required when pixAccountType is EMAIL.","type":"string"},"pixPhone":{"description":"PIX phone number key. Required when pixAccountType is PHONE.","type":"string"},"symbol":{"enum":["BRL"],"type":"string"},"type":{"enum":["brl"],"type":"string"}},"required":["type","symbol","documentNumber"],"type":"object"},"BrlPixSenderMetadata":{"properties":{"accountNumber":{"description":"The sender's account number","type":"string"},"bankCode":{"description":"The bank identifier code (ISPB)","type":"string"},"bankName":{"description":"The sender's bank name","type":"string"},"documentNumber":{"description":"The sender's document number (CPF/CNPJ)","type":"string"},"documentType":{"description":"The sender's document type","type":"string"},"endToEndId":{"description":"The PIX End-to-End ID (E2E ID)","type":"string"},"senderName":{"description":"The sender's name","type":"string"},"sourceReference":{"description":"The source reference from the originating bank","type":"string"},"type":{"enum":["brl_pix"],"type":"string"}},"required":["type"],"type":"object"},"BusinessAddressAttestation":{"properties":{"type":{"enum":["businessAddress"],"type":"string","x-order":1},"registeredAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Registered business address","title":"Registered Address","x-order":2},"operatingAddressSameAsRegistration":{"description":"Whether the operating address is the same as the registered address","example":true,"type":"boolean","x-order":3},"operatingAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Operating address (required when operatingAddressSameAsRegistration is false)","title":"Operating Address","x-order":4}},"required":["type","registeredAddress","operatingAddressSameAsRegistration"],"type":"object"},"BusinessAssociatedPersonsAttestation":{"properties":{"type":{"enum":["businessAssociatedPersons"],"type":"string","x-order":1},"associatedPersonIds":{"description":"IDs of associated persons to link to this compliance review. Each ID must reference an existing associated person for the organization. At least one referenced associated person must have the CONTROL_PERSON relationship.","example":["550e8400-e29b-41d4-a716-446655440001","550e8400-e29b-41d4-a716-446655440002","550e8400-e29b-41d4-a716-446655440003"],"items":{"format":"uuid","type":"string"},"type":"array","x-order":2}},"required":["type","associatedPersonIds"],"type":"object"},"BusinessComplianceReviewResponse":{"properties":{"id":{"description":"Unique review ID","format":"uuid","type":"string","x-order":1},"tier":{"description":"The tier this review is for.","enum":["US_STANDARD","FULL"],"example":"FULL","type":"string","x-order":2},"type":{"enum":["business"],"type":"string","x-order":3},"status":{"description":"Current status of the compliance review.","oneOf":[{"$ref":"#/components/schemas/ComplianceReviewStatusDraft","title":"Draft"},{"$ref":"#/components/schemas/ComplianceReviewStatusSubmitted","title":"Submitted"},{"$ref":"#/components/schemas/ComplianceReviewStatusValidatingSubmission","title":"Validating Submission"},{"$ref":"#/components/schemas/ComplianceReviewStatusSubmissionValidationsFailed","title":"Submission Validations Failed"},{"$ref":"#/components/schemas/ComplianceReviewStatusInReview","title":"In Review"},{"$ref":"#/components/schemas/ComplianceReviewStatusAdditionalInformationRequested","title":"Additional Information Requested"},{"$ref":"#/components/schemas/ComplianceReviewStatusApproved","title":"Approved"},{"$ref":"#/components/schemas/ComplianceReviewStatusRejected","title":"Rejected"},{"$ref":"#/components/schemas/ComplianceReviewStatusError","title":"Error"}],"x-order":4},"createdAt":{"description":"ISO 8601 timestamp when the review was created.","example":"2026-02-24T12:00:00.000Z","type":"string","x-order":5},"requiredAttestations":{"description":"Attestation types required to submit this review.","items":{"$ref":"#/components/schemas/AttestationRequirement"},"type":"array","x-order":6},"uploadedAttestations":{"description":"Attestations already uploaded for this review.","example":[],"items":{"$ref":"#/components/schemas/AttestationSummary"},"type":"array","x-order":7},"associatedPersons":{"description":"Associated persons (beneficial owners and the control person) for this business review. Up to four beneficial owners plus one control person, who may be the same individual as one of the beneficial owners.","items":{"$ref":"#/components/schemas/AssociatedPersonResource"},"type":"array","x-order":8}},"required":["id","tier","type","status","createdAt","requiredAttestations","uploadedAttestations","associatedPersons"],"type":"object"},"BusinessContactInfoAttestation":{"properties":{"type":{"enum":["businessContactInfo"],"type":"string","x-order":1},"phoneNumber":{"description":"Business phone number, including country code (e.g. +12125551234)","example":"+12125551234","type":"string","x-order":2},"email":{"description":"Business email address","example":"contact@acme.com","type":"string","x-order":3}},"required":["type","phoneNumber","email"],"type":"object"},"BusinessCounterparty":{"properties":{"createdAt":{"type":"string"},"email":{"format":"email","type":"string"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"physicalAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressInput"}],"description":"The physical address of the business counterparty."},"type":{"enum":["business"],"type":"string"},"updatedAt":{"type":"string"}},"required":["type","id","createdAt","updatedAt","name","physicalAddress"],"type":"object"},"BusinessCounterpartyInfo":{"properties":{"email":{"description":"Email address for the counterparty. When provided, must be unique within the organization. Some destination rails (for example Colombian COP payouts) require an email on either the counterparty or its payout method — if missing for those rails, payout-method or payout-request creation will fail with `additional_counterparty_information_required` (counterparty endpoint) or `additional_recipient_information_required` (payout-request endpoint) listing the missing fields.","format":"email","type":"string"},"name":{"type":"string"},"physicalAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"The physical address of the business counterparty."},"type":{"enum":["business"],"type":"string"}},"required":["type","name","physicalAddress"],"type":"object"},"BusinessDetails":{"description":"Business Details","properties":{"businessDescription":{"description":"Description of Business Activities. We recommend providing between 100 and 500 characters for a thorough description.","example":"Software development company","maxLength":500,"minLength":100,"title":"Business Description","type":"string"},"businessWebsite":{"description":"Business Website URL","example":"https://acme.com","format":"uri","title":"Business Website","type":"string"},"customerFundsTransmissionDetails":{"description":"Additional Business Details if Transmitting Customer Funds","example":"","title":"Customer Funds Transmission Details","type":"string"},"dateOfIncorporation":{"description":"Date of Incorporation (YYYY-MM-DD)","example":"2020-01-01","title":"Date of Incorporation","type":"string"},"expectedCounterpartyCountries":{"description":"List of ISO 3166-1 alpha-2 country codes representing the countries where the business expects to send or receive funds from counterparties.","example":["US","MX","CO"],"items":{"type":"array"},"title":"Expected Counterparty Countries","type":"array"},"industry":{"description":"Industry Classification","enum":["AGRICULTURE_FORESTRY_FISHING_HUNTING","MINING_QUARRYING_OIL_GAS_EXTRACTION","UTILITIES","CONSTRUCTION","MANUFACTURING","WHOLESALE_TRADE","TRANSPORTATION_AND_WAREHOUSING","INFORMATION_AND_SOFTWARE","FINANCE_AND_INSURANCE","PROFESSIONAL_AND_TECHNICAL_SERVICES","MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES","ADMINISTRATIVE_AND_SUPPORT_SERVICES","PUBLIC_ADMINISTRATION","EDUCATIONAL_SERVICES","HEALTH_CARE_AND_SOCIAL_ASSISTANCE","ARTS_ENTERTAINMENT_AND_RECREATION","ACCOMMODATION_AND_FOOD_SERVICES","OTHER_SERVICES"],"example":"INFORMATION_AND_SOFTWARE","title":"Industry","type":"string"},"legalStructure":{"description":"Legal Structure of the Business","enum":["CORPORATION","LLC","PARTNERSHIP","SOLE_PROPRIETORSHIP","TRUST","NON_PROFIT_ORGANIZATION","FOUNDATION","DAO","COOPERATIVE"],"example":"CORPORATION","title":"Legal Structure","type":"string"},"primaryTargetMarket":{"description":"Primary target market for the business. Required for business verification. If OTHER is selected, primaryTargetMarketOtherDescription must also be provided.","enum":["COMMERCIAL","RETAIL","GOVERNMENT","OTHER"],"example":"COMMERCIAL","title":"Primary Target Market","type":"string"},"primaryTargetMarketOtherDescription":{"description":"Description of the primary target market when primaryTargetMarket is OTHER. Must be between 3 and 500 characters.","example":"Non-profit organizations and NGOs","maxLength":500,"minLength":3,"title":"Primary Target Market Other Description","type":"string"},"transmittingCustomerFunds":{"description":"Whether Business Transmits Customer Funds","example":false,"title":"Transmitting Customer Funds","type":"boolean"},"usageOfMural":{"description":"How the Business Will Use Mural","example":"Vendor and supplier payments to Colombia","title":"Usage of Mural","type":"string"}},"required":["businessWebsite","legalStructure","dateOfIncorporation","industry","businessDescription","usageOfMural","transmittingCustomerFunds"],"type":"object"},"BusinessDetailsAttestation":{"properties":{"type":{"enum":["businessDetails"],"type":"string","x-order":1},"businessWebsite":{"description":"Business website URL","example":"https://acme.com","type":"string","x-order":2},"legalStructure":{"description":"Legal structure of the business","enum":["CORPORATION","LLC","PARTNERSHIP","SOLE_PROPRIETORSHIP","TRUST","NON_PROFIT_ORGANIZATION","FOUNDATION","DAO","COOPERATIVE"],"example":"CORPORATION","type":"string","x-order":3},"dateOfIncorporation":{"description":"Date of incorporation (YYYY-MM-DD)","example":"2020-01-01","type":"string","x-order":4},"industry":{"description":"Industry classification","enum":["AGRICULTURE_FORESTRY_FISHING_HUNTING","MINING_QUARRYING_OIL_GAS_EXTRACTION","UTILITIES","CONSTRUCTION","MANUFACTURING","WHOLESALE_TRADE","TRANSPORTATION_AND_WAREHOUSING","INFORMATION_AND_SOFTWARE","FINANCE_AND_INSURANCE","PROFESSIONAL_AND_TECHNICAL_SERVICES","MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES","ADMINISTRATIVE_AND_SUPPORT_SERVICES","PUBLIC_ADMINISTRATION","EDUCATIONAL_SERVICES","HEALTH_CARE_AND_SOCIAL_ASSISTANCE","ARTS_ENTERTAINMENT_AND_RECREATION","ACCOMMODATION_AND_FOOD_SERVICES","OTHER_SERVICES"],"example":"INFORMATION_AND_SOFTWARE","type":"string","x-order":5},"businessDescription":{"description":"Description of business activities. Must be at least 100 characters so reviewers can assess the nature of the business.","example":"We build cross-border payroll software that helps small businesses pay contractors in Latin America. Our platform converts USD into local currencies and routes payments through licensed banking partners.","maxLength":4000,"minLength":100,"type":"string","x-order":6},"intendedMuralUsage":{"description":"How the business intends to use Mural","example":"Vendor and supplier payments to Colombia","type":"string","x-order":7}},"required":["type","businessWebsite","legalStructure","dateOfIncorporation","industry","businessDescription","intendedMuralUsage"],"type":"object"},"BusinessEndUserCustodialOrgRequest":{"properties":{"approvers":{"description":"The approvers of this organization","items":{"$ref":"#/components/schemas/NewThirdPartyUser"},"type":"array"},"businessName":{"description":"The name of the business","type":"string"},"email":{"description":"The primary email address of the business","type":"string"},"tosRelianceInfo":{"allOf":[{"$ref":"#/components/schemas/TOSRelianceInfo"}],"description":"Optional Terms of Service reliance information. TOS reliance must be enabled by the Mural technical team to use this field."},"type":{"enum":["endUserCustodialBusiness"],"type":"string"}},"required":["type","businessName","email","approvers"],"type":"object"},"BusinessEndUserCustodialOrganization":{"properties":{"approvers":{"description":"The approvers of this organization","items":{"$ref":"#/components/schemas/ThirdPartyUser"},"type":"array"},"complianceInfo":{"allOf":[{"$ref":"#/components/schemas/OrganizationComplianceInfo"}],"description":"Compliance tier information for this organization."},"createdAt":{"format":"date-time","type":"string"},"currencyCapabilities":{"description":"The currencies that the business organization can use to fund a Mural account or pay/withdrawal from a Mural account","items":{"$ref":"#/components/schemas/MuralCurrencyCapability"},"type":"array"},"id":{"format":"uuid","type":"string"},"kycStatus":{"description":"The KYC verification status of the business","oneOf":[{"$ref":"#/components/schemas/VerificationStatusInactive"},{"$ref":"#/components/schemas/VerificationStatusPending"},{"$ref":"#/components/schemas/VerificationStatusApproved"},{"$ref":"#/components/schemas/VerificationStatusError"},{"$ref":"#/components/schemas/VerificationStatusRejected"}]},"name":{"type":"string"},"tosStatus":{"description":"The terms of service status of the business","enum":["NOT_ACCEPTED","NEEDS_REVIEW","ACCEPTED"],"type":"string"},"type":{"enum":["endUserCustodialBusiness"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["type","id","createdAt","updatedAt","name","approvers","tosStatus","kycStatus","currencyCapabilities","complianceInfo"],"type":"object"},"BusinessFinancialDetails":{"description":"Business Financial Details","properties":{"annualRevenue":{"description":"Annual Revenue Range (USD)","enum":["LESS_THAN_100K","BETWEEN_100K_AND_1M","BETWEEN_1M_AND_10M","BETWEEN_10M_AND_50M","BETWEEN_50M_AND_250M","MORE_THAN_250M"],"example":"BETWEEN_1M_AND_10M","title":"Annual Revenue","type":"string"},"estimatedMonthlyVolume":{"description":"Estimated Monthly Transaction Volume","example":50000,"minimum":0,"title":"Estimated Monthly Volume","type":"number"},"highRiskBusinessActivities":{"description":"High Risk Business Activities","example":["MONEY_SERVICES","LENDING_BANKING"],"items":{"enum":["MONEY_SERVICES","LENDING_BANKING","HOLD_CLIENT_FUNDS","FOREIGN_EXCHANGE","VIRTUAL_CURRENCIES_BROKERAGE","OTC","INVESTMENT_SERVICES","THIRD_PARTY_PAYMENT_PROCESSING","MARIJUANA_SERVICES","ADULT_ENTERTAINMENT","WEAPONS_FIREARMS_EXPLOSIVES","GAMBLING"],"type":"string"},"title":"High Risk Business Activities","type":"array"},"primaryIncomeSourceCategory":{"description":"Primary Income Source Category","enum":["BUSINESS_REVENUE","EQUITY_FUNDING","INVESTMENT_PROCEEDS","BUSINESS_LOANS","SALE_OF_ASSETS","THIRD_PARTY_FUNDS","LEGAL_SETTLEMENTS_TAX_REFUNDS","GRANTS","OTHER"],"example":"BUSINESS_REVENUE","title":"Primary Income Source Category","type":"string"},"primaryIncomeSourceDescription":{"description":"Description of Primary Income Source","example":"Software licensing and services","title":"Primary Income Source Description","type":"string"}},"required":["primaryIncomeSourceCategory","primaryIncomeSourceDescription","annualRevenue","estimatedMonthlyVolume"],"type":"object"},"BusinessFinancialInfoAttestation":{"properties":{"type":{"enum":["businessFinancialInfo"],"type":"string","x-order":1},"primaryIncomeSourceCategory":{"description":"Primary income source category","enum":["BUSINESS_REVENUE","EQUITY_FUNDING","INVESTMENT_PROCEEDS","BUSINESS_LOANS","SALE_OF_ASSETS","THIRD_PARTY_FUNDS","LEGAL_SETTLEMENTS_TAX_REFUNDS","GRANTS","OTHER"],"example":"BUSINESS_REVENUE","type":"string","x-order":2},"primaryIncomeSourceDescription":{"description":"Description of primary income source","example":"Software licensing and services","type":"string","x-order":3},"annualRevenue":{"description":"Annual revenue range (USD)","enum":["LESS_THAN_100K","BETWEEN_100K_AND_1M","BETWEEN_1M_AND_10M","BETWEEN_10M_AND_50M","BETWEEN_50M_AND_250M","MORE_THAN_250M"],"example":"BETWEEN_1M_AND_10M","type":"string","x-order":4},"estimatedMonthlyVolume":{"description":"Estimated monthly transaction volume in USD","example":50000,"minimum":1,"type":"number","x-order":5}},"required":["type","primaryIncomeSourceCategory","primaryIncomeSourceDescription","annualRevenue","estimatedMonthlyVolume"],"type":"object"},"BusinessFlowOfFundsDocumentAttestation":{"properties":{"type":{"enum":["businessFlowOfFundsDocument"],"type":"string","x-order":1},"document":{"allOf":[{"$ref":"#/components/schemas/FlowOfFundsDocumentReference"}],"description":"Flow of funds document reference","x-order":2}},"required":["type","document"],"type":"object"},"BusinessFormationDocumentsAttestation":{"properties":{"type":{"enum":["businessFormationDocuments"],"type":"string","x-order":1},"formationDocuments":{"description":"Formation documents (e.g., articles of incorporation)","items":{"$ref":"#/components/schemas/FormationDocumentReference"},"type":"array","x-order":2}},"required":["type","formationDocuments"],"type":"object"},"BusinessIdentificationAttestation":{"properties":{"type":{"enum":["businessIdentification"],"type":"string","x-order":1},"businessName":{"description":"Legal business name","example":"Acme Corp","type":"string","x-order":2},"registrationNumber":{"description":"Business registration number","example":"REG123456","type":"string","x-order":3},"dbaName":{"description":"Doing Business As (DBA) name","example":"Acme","type":"string","x-order":4}},"required":["type","businessName"],"type":"object"},"BusinessIdentificationInfo":{"description":"Business Identification information","properties":{"businessAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Business Address","title":"Business Address"},"businessEmail":{"description":"Business Email Address","example":"contact@acme.com","format":"email","title":"Business Email","type":"string"},"businessName":{"description":"Legal Business Name","example":"Acme Corp","title":"Business Name","type":"string"},"businessPhoneNumber":{"description":"Business Phone Number","example":"+1-212-555-1234","title":"Business Phone Number","type":"string"},"dbaName":{"description":"Doing Business As Name","example":"Acme","title":"DBA Name","type":"string"},"operatingAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Operating address of the business. Required when operatingAddressSameAsRegistration is false.","title":"Operating Address"},"operatingAddressSameAsRegistration":{"description":"Whether the operating address is the same as the registered business address. When false, operatingAddress must be provided.","example":true,"title":"Operating Address Same As Registration","type":"boolean"},"registrationNumber":{"description":"Business Registration Number","example":"REG123456","title":"Registration Number","type":"string"},"taxIdentificationNumber":{"allOf":[{"$ref":"#/components/schemas/TaxIdentificationNumber"}],"description":"Tax ID Number","example":{"taxIdentificationNumber":"12-3456789","taxIdentificationNumberType":"EIN"},"title":"Tax Identification Number"}},"required":["businessName","taxIdentificationNumber","businessAddress","businessPhoneNumber","businessEmail"],"type":"object"},"BusinessOperationsAttestation":{"properties":{"type":{"enum":["businessOperations"],"type":"string","x-order":1},"transmittingCustomerFunds":{"description":"Whether the business transmits customer funds","example":false,"type":"boolean","x-order":2},"customerFundsTransmissionDetails":{"description":"Details about customer funds transmission (required when transmittingCustomerFunds is true)","type":"string","x-order":3},"primaryTargetMarket":{"description":"Primary target market","enum":["COMMERCIAL","RETAIL","GOVERNMENT","OTHER"],"example":"COMMERCIAL","type":"string","x-order":4},"primaryTargetMarketOtherDescription":{"description":"Description of primary target market (required when primaryTargetMarket is OTHER)","type":"string","x-order":5},"expectedCounterpartyCountries":{"description":"Expected counterparty countries (ISO 3166-1 alpha-2 codes)","example":["CO","MX"],"items":{"type":"string"},"type":"array","x-order":6},"highRiskBusinessActivities":{"description":"High risk business activities the business is engaged in. Submit an empty array to attest the business is engaged in none of the listed activities.","items":{"enum":["MONEY_SERVICES","LENDING_BANKING","HOLD_CLIENT_FUNDS","FOREIGN_EXCHANGE","VIRTUAL_CURRENCIES_BROKERAGE","OTC","INVESTMENT_SERVICES","THIRD_PARTY_PAYMENT_PROCESSING","MARIJUANA_SERVICES","ADULT_ENTERTAINMENT","WEAPONS_FIREARMS_EXPLOSIVES","GAMBLING"],"type":"string"},"type":"array","x-order":7}},"required":["type","transmittingCustomerFunds","primaryTargetMarket","expectedCounterpartyCountries","highRiskBusinessActivities"],"type":"object"},"BusinessOrgRequest":{"properties":{"businessName":{"description":"The name of the business","type":"string"},"email":{"description":"The primary email address of the business","type":"string"},"tosRelianceInfo":{"allOf":[{"$ref":"#/components/schemas/TOSRelianceInfo"}],"description":"Optional Terms of Service reliance information. TOS reliance must be enabled by the Mural technical team to use this field."},"type":{"enum":["business"],"type":"string"}},"required":["type","businessName","email"],"type":"object"},"BusinessOrganization":{"properties":{"complianceInfo":{"allOf":[{"$ref":"#/components/schemas/OrganizationComplianceInfo"}],"description":"Compliance tier information for this organization."},"createdAt":{"format":"date-time","type":"string"},"currencyCapabilities":{"description":"The currencies that the business organization can use to fund a Mural account or pay/withdrawal from a Mural account","items":{"$ref":"#/components/schemas/MuralCurrencyCapability"},"type":"array"},"id":{"format":"uuid","type":"string"},"kycStatus":{"description":"The KYC verification status of the business","oneOf":[{"$ref":"#/components/schemas/VerificationStatusInactive"},{"$ref":"#/components/schemas/VerificationStatusPending"},{"$ref":"#/components/schemas/VerificationStatusApproved"},{"$ref":"#/components/schemas/VerificationStatusError"},{"$ref":"#/components/schemas/VerificationStatusRejected"}]},"name":{"type":"string"},"tosStatus":{"description":"The terms of service status of the business","enum":["NOT_ACCEPTED","NEEDS_REVIEW","ACCEPTED"],"type":"string"},"type":{"enum":["business"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["type","id","createdAt","updatedAt","name","tosStatus","kycStatus","currencyCapabilities","complianceInfo"],"type":"object"},"BusinessProofOfAddressDocumentReference":{"properties":{"documentType":{"description":"The type of business proof-of-address document","enum":["UTILITY_BILL","BANK_STATEMENT","GOVERNMENT_ISSUED_LETTER"],"example":"UTILITY_BILL","type":"string","x-order":1},"documentId":{"description":"The document ID returned by the document upload endpoint after a successful upload.","format":"uuid","type":"string","x-order":2}},"required":["documentType","documentId"],"type":"object"},"BusinessProofOfAddressDocumentsAttestation":{"properties":{"type":{"enum":["businessProofOfAddressDocuments"],"type":"string","x-order":1},"proofOfAddressDocuments":{"description":"Proof of address documents","items":{"$ref":"#/components/schemas/BusinessProofOfAddressDocumentReference"},"type":"array","x-order":2}},"required":["type","proofOfAddressDocuments"],"type":"object"},"BusinessRecipientInfo":{"properties":{"email":{"description":"Email address for the recipient. Some destination rails (for example Colombian COP payouts) require an email — if missing for those rails, payout-request creation will fail with `additional_recipient_information_required` listing the missing fields.","format":"email","type":"string"},"name":{"type":"string"},"physicalAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressInput"}],"description":"The physical address of the recipient business."},"type":{"enum":["business"],"type":"string"}},"required":["type","name","physicalAddress"],"type":"object"},"BusinessTaxInfoAttestation":{"properties":{"type":{"enum":["businessTaxInfo"],"type":"string","x-order":1},"taxIdentificationNumber":{"description":"Tax identification number.","example":"12-3456789","type":"string","x-order":2},"taxIdentificationNumberType":{"description":"Type of tax identification number","enum":["EIN","CNPJ","CUIT","RFC","NIT","RUC","SIRET","SIREN","CRN","KBO","KVK","PARTITA_IVA","VAT","NIF","GSTIN","ABN","ACN","ADOSZAM","ARBN","BCE","BIN_BD","BIN_KZ","BN","BRN","CEDULA_JURIDICA","CIN","CR","CRO","CVR","EDB","EDRPOU","EN","FN","GST","HN","ICE","ICO","IDU","IMONES_KODAS","MATICNA","NINEA","NIP","NIPT","OGRN","ORGNR","RCCM","REGISTRIKOOD","RN","RNC","SSM","UEN","UIC","UID","USC","UST_IDNR","VKN","Y_TUNNUS","BIR","BIN","BP","CF","CN","CRIB","CUI","ID","ID_BROJ","IDNO","IF","INN","IRD","MATRICULE","MST","NPWP","NRT","NTN","OIB","PAN","PIB","RC","RIF","RTN","RUT","TIN","TRN","UNP","VOEN"],"example":"EIN","type":"string","x-order":3}},"required":["type","taxIdentificationNumber","taxIdentificationNumberType"],"type":"object"},"BusinessUboOwnershipDocumentsAttestation":{"properties":{"type":{"enum":["businessUboOwnershipDocuments"],"type":"string","x-order":1},"uboOwnershipDocuments":{"description":"UBO ownership documents","items":{"$ref":"#/components/schemas/UboOwnershipDocumentReference"},"type":"array","x-order":2}},"required":["type","uboOwnershipDocuments"],"type":"object"},"CLPDomesticPayoutMethodDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_clp_001","type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["CLP"],"type":"string"},"type":{"enum":["clpDomestic"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","documentType","documentNumber","bankId"],"type":"object"},"CLPDomesticPayoutMethodResponseDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****5678","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_clp_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****78-9","type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["CLP"],"type":"string"},"type":{"enum":["clpDomestic"],"type":"string"}},"required":["type","symbol","accountType","documentType","bankId","bankAccountNumberTruncated","documentNumberTruncated"],"type":"object"},"CLPPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/CLPDomesticPayoutMethodDetails","title":"CLP Domestic"}]},"type":{"enum":["clp"],"type":"string"}},"required":["type","details"],"type":"object"},"CLPPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/CLPDomesticPayoutMethodResponseDetails","title":"CLP Domestic"}]},"type":{"enum":["clp"],"type":"string"}},"required":["type","details"],"type":"object"},"COPBreBPayinAmount":{"description":"COP amount in cents.","properties":{"currencySymbol":{"description":"Must be `COP`.","enum":["COP"],"example":"COP","type":"string"},"value":{"description":"Amount in cents (e.g. `\"1230000\"` = 12,300.00 COP).","example":"1230000","type":"string"}},"required":["currencySymbol","value"],"type":"object"},"COPBreBPayinCreationDetails":{"description":"Details for creating a Bre-B pay-in. Payments must exactly match the requested amount; mismatched payments are declined.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/COPBreBPayinAmount"}],"description":"The amount the payer must send.","example":{"currencySymbol":"COP","value":"1230000"}},"descriptionToPayee":{"description":"Short description recorded on the resulting pay-in in your Mural account.","example":"Order #001","maxLength":256,"type":"string"},"descriptionToPayer":{"description":"Short description shown to the payer in their banking app while they confirm the transfer.","example":"Order #001 payment","maxLength":256,"type":"string"},"expiresInSeconds":{"description":"Number of seconds until the Bre-B key expires. Defaults to 300 seconds (5 minutes) if omitted. Minimum is 300 seconds (5 minutes). Maximum is 259200 seconds (3 days).","maximum":259200,"minimum":300,"type":"integer"},"payerName":{"description":"Full legal name of the payer. For individuals this is their full name; for businesses this is the registered business name.","example":"Fernando Alonso","maxLength":255,"minLength":2,"type":"string"},"type":{"enum":["cop-bre-b"],"type":"string"}},"required":["type","amount","payerName","descriptionToPayer","descriptionToPayee"],"type":"object"},"COPBreBPayinInstructions":{"description":"Instructions for a Colombian Bre-B pay-in intent.","properties":{"descriptionToPayer":{"description":"The description supplied at creation, for displaying alongside the key in your checkout UI.","example":"Order #001 payment","maxLength":256,"type":"string"},"expiresAt":{"description":"The date and time the key expires. After this, the key can no longer receive payment.","format":"date-time","type":"string"},"keyValue":{"description":"The Bre-B key the payer enters in their Colombian banking app. Single-use, time-bound, and locked to the requested amount.","example":"@CBF0JHIDU","type":"string"},"type":{"enum":["cop-bre-b"],"type":"string"}},"required":["type","keyValue","expiresAt","descriptionToPayer"],"type":"object"},"COPBreBPayinRailDetails":{"properties":{"currency":{"enum":["COP"],"type":"string"},"keyValue":{"description":"Bre-B key value (alphanumeric identifier like @CB...) registered in the real-time payments network.","type":"string"},"payinRail":{"enum":["BRE_B"],"type":"string"},"type":{"enum":["cop-bre-b"],"type":"string"}},"required":["type","currency","payinRail","keyValue"],"type":"object"},"COPBreBPayoutMethodDetails":{"properties":{"keyValue":{"description":"Bre-B key value (alphanumeric identifier like @CB...) registered in the real-time payments network","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["copBreB"],"type":"string"}},"required":["type","symbol","keyValue"],"type":"object"},"COPBreBPayoutMethodResponseDetails":{"properties":{"keyValueTruncated":{"description":"Masked Bre-B key value (format: ****1234)","example":"****XD8","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["copBreB"],"type":"string"}},"required":["type","symbol","keyValueTruncated"],"type":"object"},"COPBreBSenderMetadata":{"description":"Sender metadata for COP Bre-B pay-ins. Individual fields may be undefined depending on what the originating bank provides.","properties":{"senderAccountNumber":{"description":"Payer's bank account number (unformatted).","example":"987654321","type":"string"},"senderAccountType":{"description":"Payer's bank account type. `corriente` (checking), `ahorros` (savings), `deposito` (electronic deposit).","example":"ahorros","type":"string"},"senderBankCode":{"description":"Colombian financial-institution code of the payer's bank (4-digit numeric).","example":"1007","type":"string"},"senderId":{"description":"Payer's Colombian identification number. Format matches `senderIdType` (e.g. a 10-digit cédula for `cc`, a NIT with check digit for `nit`).","example":"1234567890","type":"string"},"senderIdType":{"description":"Payer's Colombian identification type. `cc` = cédula de ciudadanía, `nit` = tax ID, `ce` = foreign-resident ID, `pa` = passport, `ppt` = temporary protection permit, `ti` = minor ID, `rc` = birth certificate, `te` = foreign ID, `die` = diplomatic ID.","enum":["cc","nit","ce","pa","ppt","ti","rc","te","die"],"example":"cc","type":"string"},"senderName":{"description":"Payer's full name.","example":"Juan Perez","type":"string"},"type":{"enum":["cop-bre-b"],"type":"string"}},"required":["type"],"type":"object"},"COPCobreBalancePayoutMethodDetails":{"properties":{"cobreTag":{"description":"Cobre balance tag (unique identifier for the recipient's Cobre balance, e.g. @cwvc1212)","type":"string"},"documentNumber":{"description":"Identification number of the counterparty. Special characters are not allowed.","type":"string"},"documentType":{"description":"Identification type of the counterparty","enum":["NATIONAL_ID","RUC_NIT","PASSPORT","RESIDENT_ID"],"type":"string"},"email":{"description":"Email address of the counterparty","format":"email","type":"string"},"phoneNumber":{"description":"Counterparty phone. Must contain the country code.","format":"phone","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["copCobreBalance"],"type":"string"}},"required":["type","symbol","cobreTag","documentType","documentNumber"],"type":"object"},"COPCobreBalancePayoutMethodResponseDetails":{"properties":{"cobreTagTruncated":{"description":"Masked Cobre balance tag (format: ****1212)","example":"****1212","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["copCobreBalance"],"type":"string"}},"required":["type","symbol","cobreTagTruncated"],"type":"object"},"COPCreatePayinInstructions":{"properties":{"depositUrl":{"description":"The URL to the COP PSE deposit page.","type":"string"},"expiresAt":{"description":"The date and time the deposit URL will expire.","format":"date-time","type":"string"},"redirectUrl":{"description":"URL the user is redirected to after successful payment submission. Not used on failure; please handle the failure experience in your application. Defaults to a generic confirmation page on muralpay.com.","type":"string"},"type":{"enum":["cop"],"type":"string"}},"required":["type","depositUrl","expiresAt","redirectUrl"],"type":"object"},"COPDomesticPayoutMethodDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_cop_001","type":"string"},"documentNumber":{"description":"Identification number of the counterparty. Special characters are not allowed.","type":"string"},"documentType":{"description":"Identification type of the counterparty","enum":["NATIONAL_ID","RUC_NIT","PASSPORT","RESIDENT_ID"],"type":"string"},"phoneNumber":{"format":"phone","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["copDomestic"],"type":"string"}},"required":["type","symbol","phoneNumber","accountType","bankAccountNumber","documentNumber","documentType","bankId"],"type":"object"},"COPDomesticPayoutMethodResponseDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****8901","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_cop_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****7890","type":"string"},"documentType":{"enum":["NATIONAL_ID","RUC_NIT","PASSPORT","RESIDENT_ID"],"type":"string"},"phoneNumberTruncated":{"description":"Masked phone number (format: ****1234)","example":"****4567","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["copDomestic"],"type":"string"}},"required":["type","symbol","accountType","documentType","bankId","phoneNumberTruncated","documentNumberTruncated","bankAccountNumberTruncated"],"type":"object"},"COPFiatAmount":{"properties":{"type":{"enum":["fiat"],"example":"fiat","type":"string","x-order":1},"currencySymbol":{"description":"The ISO 4217 currency code.","enum":["COP"],"example":"COP","type":"string","x-order":2},"value":{"description":"Integer amount in COP (e.g. \"12300\" represents 12,300 COP).","example":"12300","type":"string","x-order":3}},"required":["type","currencySymbol","value"],"type":"object"},"COPFundingBankAccount":{"properties":{"accountHolderDocumentNumber":{"description":"Document number of the account holder.","type":"string"},"accountHolderDocumentType":{"description":"Document type of the account holder (e.g. NIT).","type":"string"},"accountHolderName":{"description":"Name of the account holder.","type":"string"},"accountNumber":{"description":"Bank account number.","type":"string"},"accountType":{"description":"Bank account type (e.g. CHECKING, SAVINGS).","type":"string"},"bankName":{"description":"Name of the bank.","type":"string"},"type":{"enum":["cop"],"type":"string"}},"required":["type","bankName","accountType","accountNumber","accountHolderName","accountHolderDocumentType","accountHolderDocumentNumber"],"type":"object"},"COPPayinCreationDetails":{"properties":{"expiresInSeconds":{"description":"Number of seconds until the payment link expires. Defaults to 7 days (604800 seconds) if omitted. Minimum is 60 seconds. Maximum is 7 days (604800 seconds).","type":"number"},"fiatAmount":{"description":"The fiat amount for the payin.","type":"number"},"fiatCurrencyCode":{"enum":["COP"],"type":"string"},"redirectUrl":{"description":"URL to redirect the user to after successful payment submission. Not used on failure; please handle the failure experience in your application. Defaults to a generic confirmation page on muralpay.com.","type":"string"},"type":{"enum":["cop"],"type":"string"}},"required":["type","fiatCurrencyCode","fiatAmount"],"type":"object"},"COPPayinInstructions":{"properties":{"depositUrl":{"description":"The URL to the COP PSE deposit page.","type":"string"},"expiresAt":{"description":"The date and time the deposit URL will expire.","format":"date-time","type":"string"},"type":{"enum":["cop"],"type":"string"}},"required":["type","depositUrl","expiresAt"],"type":"object"},"COPPayinRailDetails":{"properties":{"currency":{"enum":["COP"],"type":"string"},"payinRail":{"enum":["PSE"],"type":"string"},"type":{"enum":["cop"],"type":"string"}},"required":["type","currency","payinRail"],"type":"object"},"COPPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/COPDomesticPayoutMethodDetails","title":"COP Domestic"},{"$ref":"#/components/schemas/COPBreBPayoutMethodDetails","title":"COP BRE-B"}]},"type":{"enum":["cop"],"type":"string"}},"required":["type","details"],"type":"object"},"COPPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/COPDomesticPayoutMethodResponseDetails","title":"COP Domestic"},{"$ref":"#/components/schemas/COPBreBPayoutMethodResponseDetails","title":"COP BRE-B"}]},"type":{"enum":["cop"],"type":"string"}},"required":["type","details"],"type":"object"},"CRCDomesticPayoutMethodDetails":{"properties":{"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_crc_001","type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"iban":{"type":"string"},"symbol":{"enum":["CRC"],"type":"string"},"type":{"enum":["crcDomestic"],"type":"string"}},"required":["type","symbol","iban","documentNumber","documentType","bankId"],"type":"object"},"CRCDomesticPayoutMethodResponseDetails":{"properties":{"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_crc_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****9012","type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"ibanTruncated":{"description":"Masked IBAN (format: ****1234)","example":"****4066","type":"string"},"symbol":{"enum":["CRC"],"type":"string"},"type":{"enum":["crcDomestic"],"type":"string"}},"required":["type","symbol","documentType","bankId","ibanTruncated","documentNumberTruncated"],"type":"object"},"CRCPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/CRCDomesticPayoutMethodDetails","title":"CRC Domestic"}]},"type":{"enum":["crc"],"type":"string"}},"required":["type","details"],"type":"object"},"CRCPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/CRCDomesticPayoutMethodResponseDetails","title":"CRC Domestic"}]},"type":{"enum":["crc"],"type":"string"}},"required":["type","details"],"type":"object"},"CitizenshipCertificateGovernmentId":{"description":"Citizenship certificate - typically single-sided document","properties":{"citizenshipCertificateBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of citizenship certificate document with filename and base64 content (if applicable)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"citizenship_cert_back.pdf"},"title":"Citizenship Certificate Back Document"},"citizenshipCertificateDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of citizenship certificate document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"citizenship_cert.pdf"},"title":"Citizenship Certificate Document"},"citizenshipCertificateNumber":{"description":"Citizenship Certificate Number","example":"CC12345678","title":"Citizenship Certificate Number","type":"string"},"countryCode":{"description":"Country Code of Citizenship Certificate Issuer (ISO 3166-1 alpha-2)","example":"CA","title":"Country Code","type":"string"},"type":{"enum":["citizenshipCertificate"],"type":"string"}},"required":["type","citizenshipCertificateNumber","countryCode","citizenshipCertificateDocument"],"type":"object"},"CitizenshipCertificateIdentityDocument":{"properties":{"citizenshipCertificateDocumentId":{"description":"File ID (UUID) of the citizenship certificate document, from the document upload endpoint.","format":"uuid","type":"string"},"citizenshipCertificateNumber":{"description":"Citizenship certificate number","example":"1234567","type":"string"},"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"CA","type":"string"},"type":{"enum":["citizenshipCertificate"],"type":"string"}},"required":["type","countryCode","citizenshipCertificateNumber","citizenshipCertificateDocumentId"],"title":"Citizenship Certificate","type":"object"},"ClpDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["CLP"],"type":"string"},"type":{"enum":["clp"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","documentType","documentNumber"],"type":"object"},"CnhGovernmentId":{"description":"Brazilian driver license (CNH). Requires a front document; the back is optional because a CNH may be submitted as a single combined image.","properties":{"cnhBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of the CNH document with filename and base64 content. Optional for a CNH submitted as a single combined image (front and back on one page).","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"cnh_back.pdf"},"title":"CNH Back Document"},"cnhFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of the CNH document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"cnh_front.pdf"},"title":"CNH Front Document"},"cnhNumber":{"description":"CNH registration number","example":"CNH12345678","title":"CNH Number","type":"string"},"type":{"enum":["cnh"],"type":"string"}},"required":["type","cnhNumber","cnhFrontDocument"],"type":"object"},"CnhIdentityDocument":{"properties":{"cnhBackDocumentId":{"description":"File ID (UUID) of the CNH back. Optional — a CNH may be a single combined image.","format":"uuid","type":"string"},"cnhFrontDocumentId":{"description":"File ID (UUID) of the CNH front, from the document upload endpoint.","format":"uuid","type":"string"},"cnhNumber":{"description":"CNH registration number","example":"CNH12345678","type":"string"},"type":{"enum":["cnh"],"type":"string"}},"required":["type","cnhNumber","cnhFrontDocumentId"],"title":"CNH (Brazilian Driver's License)","type":"object"},"ComplianceReviewStatusAdditionalInformationRequested":{"description":"Additional information is required before the review can proceed.","properties":{"type":{"enum":["additionalInformationRequested"],"type":"string"}},"required":["type"],"type":"object"},"ComplianceReviewStatusApproved":{"description":"The compliance review has been approved. The organization has been granted the requested KYC tier.","properties":{"approvedAt":{"description":"ISO 8601 timestamp when the review was approved.","example":"2026-02-24T12:00:00.000Z","type":"string"},"submittedAt":{"description":"ISO 8601 timestamp when the review was submitted.","example":"2026-02-24T12:00:00.000Z","type":"string"},"type":{"enum":["approved"],"type":"string"}},"required":["type","submittedAt","approvedAt"],"type":"object"},"ComplianceReviewStatusDraft":{"description":"The review has been created and is awaiting attestation uploads.","properties":{"type":{"enum":["draft"],"type":"string"}},"required":["type"],"type":"object"},"ComplianceReviewStatusError":{"description":"An error occurred while processing the review. The organization may need to create a new review.","properties":{"errorDescription":{"description":"Description of the error that occurred during processing.","example":"Verification provider returned an unexpected error.","type":"string"},"submittedAt":{"description":"ISO 8601 timestamp when the review was submitted.","example":"2026-02-24T12:00:00.000Z","type":"string"},"type":{"enum":["error"],"type":"string"}},"required":["type","submittedAt","errorDescription"],"type":"object"},"ComplianceReviewStatusInReview":{"description":"The review is currently being evaluated.","properties":{"submittedAt":{"description":"ISO 8601 timestamp when the review was submitted.","example":"2026-02-24T12:00:00.000Z","type":"string"},"type":{"enum":["inReview"],"type":"string"}},"required":["type","submittedAt"],"type":"object"},"ComplianceReviewStatusRejected":{"description":"The compliance review was rejected. See rejectionDescription for the reason.","properties":{"rejectedAt":{"description":"ISO 8601 timestamp when the review was rejected.","example":"2026-02-24T12:00:00.000Z","type":"string"},"rejectionDescription":{"description":"Description of why the compliance review was rejected.","example":"Provided information does not meet KYC requirements.","type":"string"},"submittedAt":{"description":"ISO 8601 timestamp when the review was submitted.","example":"2026-02-24T12:00:00.000Z","type":"string"},"type":{"enum":["rejected"],"type":"string"}},"required":["type","submittedAt","rejectedAt","rejectionDescription"],"type":"object"},"ComplianceReviewStatusSubmissionValidationsFailed":{"description":"One or more submission validations failed for the submitted review.","properties":{"failures":{"description":"The set of failures recorded by the most recent submit attempt. Always non-empty when the review is in this status.","items":{"$ref":"#/components/schemas/ComplianceReviewSubmissionValidationFailure"},"minItems":1,"type":"array"},"type":{"enum":["submissionValidationsFailed"],"type":"string"}},"required":["type","failures"],"type":"object"},"ComplianceReviewStatusSubmitted":{"description":"The review has been submitted and attestations have been validated. Verification processing will begin shortly.","properties":{"submittedAt":{"description":"ISO 8601 timestamp when the review was submitted.","example":"2026-02-24T12:00:00.000Z","type":"string"},"type":{"enum":["submitted"],"type":"string"}},"required":["type","submittedAt"],"type":"object"},"ComplianceReviewStatusValidatingSubmission":{"description":"Submission validations are currently running against the submitted review.","properties":{"type":{"enum":["validatingSubmission"],"type":"string"}},"required":["type"],"type":"object"},"ComplianceReviewSubmissionValidationFailure":{"description":"A single cross-attestation submission validation failure.","properties":{"failureDescription":{"description":"Human-readable description of the failure.","example":"Tax ID type CPF is not valid for country US.","type":"string"},"severity":{"description":"`BLOCKING` failures must be resolved by re-uploading attestations; `WARNING` failures can be bypassed by re-submitting with `acknowledgeWarnings: true`.","enum":["BLOCKING","WARNING"],"example":"WARNING","type":"string"},"validationCode":{"description":"The kind of failure.","enum":["TAX_ID_COUNTRY_PAIR","ASSOCIATED_PERSON_TAX_ID_COUNTRY_PAIR"],"example":"TAX_ID_COUNTRY_PAIR","type":"string"}},"required":["validationCode","severity","failureDescription"],"type":"object"},"ComplianceReviewTier":{"description":"The KYC tier this review is for.","enum":["LIGHT","STANDARD","US_STANDARD","FULL"],"type":"string"},"ComplianceValidationPayoutFailure":{"properties":{"failedChecks":{"description":"Compliance checks that failed for this payout. Possible values: `PAYMENT_VALUE_THRESHOLD`, `AGGREGATE_THIRTY_DAY_PAYOUT_VOLUME`, `INTERNAL_VALIDATION`.","items":{"enum":["PAYMENT_VALUE_THRESHOLD","AGGREGATE_THIRTY_DAY_PAYOUT_VOLUME","INTERNAL_VALIDATION"],"type":"string"},"type":"array"},"failureReasons":{"description":"Reasons why compliance validation failed for this payout. Possible values: `MISSING_SUPPORTING_DOCUMENT`, `MISSING_TRANSFER_PURPOSE`, `MAX_TRANSFER_VOLUME_LIMIT_EXCEEDED`, `UNKNOWN_FAILURE_REASON`.","items":{"enum":["MISSING_SUPPORTING_DOCUMENT","MISSING_TRANSFER_PURPOSE","MAX_TRANSFER_VOLUME_LIMIT_EXCEEDED","UNKNOWN_FAILURE_REASON"],"type":"string"},"type":"array"},"payoutIndex":{"description":"Index of the payout that failed validation","type":"number"}},"required":["payoutIndex","failureReasons","failedChecks"],"type":"object"},"ConsularIdGovernmentId":{"description":"Consular ID - requires front and back documents","properties":{"consularIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of consular ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"consular_id_back.pdf"},"title":"Consular ID Back Document"},"consularIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of consular ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"consular_id_front.pdf"},"title":"Consular ID Front Document"},"consularIdNumber":{"description":"Consular ID Number","example":"CID12345678","title":"Consular ID Number","type":"string"},"countryCode":{"description":"Country Code of Consular ID Issuer (ISO 3166-1 alpha-2)","example":"MX","title":"Country Code","type":"string"},"type":{"enum":["consularId"],"type":"string"}},"required":["type","consularIdNumber","countryCode","consularIdFrontDocument","consularIdBackDocument"],"type":"object"},"ConsularIdIdentityDocument":{"properties":{"consularIdBackDocumentId":{"description":"File ID (UUID) of the back of the consular ID, from the document upload endpoint.","format":"uuid","type":"string"},"consularIdFrontDocumentId":{"description":"File ID (UUID) of the front of the consular ID, from the document upload endpoint.","format":"uuid","type":"string"},"consularIdNumber":{"description":"Consular ID number","example":"CI1234567","type":"string"},"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"MX","type":"string"},"type":{"enum":["consularId"],"type":"string"}},"required":["type","countryCode","consularIdNumber","consularIdFrontDocumentId","consularIdBackDocumentId"],"title":"Consular ID","type":"object"},"CopBreBDetails":{"properties":{"keyValue":{"description":"Bre-B key value (alphanumeric identifier like @CB...) registered in the real-time payments network","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["cop-bre-b"],"type":"string"}},"required":["type","symbol","keyValue"],"type":"object"},"CopCobreBalanceDetails":{"properties":{"cobreTag":{"description":"Cobre balance tag (unique identifier for the recipient's Cobre balance, e.g. @cwvc1212)","type":"string"},"documentNumber":{"description":"Identification number of the counterparty. Special characters are not allowed.","type":"string"},"documentType":{"description":"Identification type of the counterparty (required by Cobre)","enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"email":{"description":"Email address of the counterparty","format":"email","type":"string"},"phoneNumber":{"description":"Counterparty phone. Must contain the country code.","format":"phone","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["cop-cobre-balance"],"type":"string"}},"required":["type","symbol","cobreTag","documentType","documentNumber"],"type":"object"},"CopDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"description":"The bank account number of the recipient","type":"string"},"documentNumber":{"description":"The document number of the recipient","type":"string"},"documentType":{"description":"The type of document that the documentNumber corresponds to","enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"phoneNumber":{"description":"The phone number of the recipient","format":"phone","type":"string"},"symbol":{"enum":["COP"],"type":"string"},"type":{"enum":["cop"],"type":"string"}},"required":["type","symbol","phoneNumber","accountType","bankAccountNumber","documentNumber","documentType"],"type":"object"},"Counterparty":{"properties":{"name":{"description":"The name of the Counterparty","type":"string"},"type":{"enum":["counterparty"],"type":"string"}},"required":["type","name"],"type":"object"},"CounterpartyEmailFilter":{"description":"Filter counterparties by exact email address (case-insensitive).","properties":{"email":{"description":"The email address to match.","format":"email","type":"string"},"type":{"enum":["email"],"type":"string"}},"required":["type","email"],"type":"object"},"CounterpartyPaginatedResponse":{"properties":{"nextId":{"description":"Cursor for fetching the next page of results","format":"uuid","type":"string"},"results":{"description":"List of counterparties","items":{"oneOf":[{"$ref":"#/components/schemas/IndividualCounterparty","title":"Individual"},{"$ref":"#/components/schemas/BusinessCounterparty","title":"Business"}]},"type":"array"},"total":{"description":"Total number of counterparties matching the filter","type":"number"}},"required":["total","results"],"type":"object"},"CounterpartyPayoutMethodDetails":{"description":"This payout details type can only be used for counterparty payouts. The recipient must be a counterparty.","properties":{"developerFee":{"allOf":[{"$ref":"#/components/schemas/DeveloperFee"}],"description":"This fee will be added to the base fees associated with this payout and it will be applied to the source token amount. Only valid for fiat payout methods. Will throw an error if used with blockchain payout methods."},"payoutMethodId":{"description":"The ID of the payout method to use","format":"uuid","type":"string"},"type":{"enum":["counterpartyPayoutMethod"],"type":"string"}},"required":["type","payoutMethodId"],"type":"object"},"CounterpartyPayoutRecipientInfo":{"description":"Recipient information for payouts created using counterparty and payout method references","properties":{"counterpartyId":{"description":"The ID of the counterparty used as the recipient","format":"uuid","type":"string"},"payoutMethodId":{"description":"The ID of the payout method used as the payout method","format":"uuid","type":"string"},"type":{"enum":["counterparty"],"type":"string"}},"required":["type","counterpartyId","payoutMethodId"],"type":"object"},"CounterpartyRecipientInfo":{"description":"This recipient type can only be used for counterparty payouts. The payout details must be a counterparty payout method.","properties":{"counterpartyId":{"description":"The ID of the counterparty to use as the recipient","format":"uuid","type":"string"},"type":{"enum":["counterpartyInfo"],"type":"string"}},"required":["type","counterpartyId"],"type":"object"},"CountriesResponse":{"properties":{"count":{"description":"Total number of countries","example":3,"type":"number"},"countries":{"description":"List of countries","items":{"$ref":"#/components/schemas/Country"},"type":"array"}},"required":["count","countries"],"type":"object"},"Country":{"properties":{"alpha2Code":{"description":"ISO 3166-1 alpha-2 country code","example":"US","type":"string"},"name":{"description":"Country name","example":"United States","type":"string"},"subdivisions":{"description":"Country subdivisions (states, provinces, etc.)","items":{"$ref":"#/components/schemas/CountrySubdivision"},"type":"array"}},"required":["name","alpha2Code","subdivisions"],"type":"object"},"CountrySubdivision":{"properties":{"code":{"description":"ISO 3166-2 subdivision code (without country prefix)","example":"NY","type":"string"},"name":{"description":"Subdivision name","example":"New York","type":"string"}},"required":["code","name"],"type":"object"},"CrcDetails":{"properties":{"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"iban":{"type":"string"},"symbol":{"enum":["CRC"],"type":"string"},"type":{"enum":["crc"],"type":"string"}},"required":["type","symbol","iban","documentNumber","documentType"],"type":"object"},"CreateAssociatedPersonRequest":{"properties":{"relationships":{"description":"The relationship(s) of this person to the business.\n\n- `BENEFICIAL_OWNER` — holds an ownership stake in the business. Declare owners with 25% or more ownership; if there are no owners at 25% or more, report the owner with the highest ownership percentage. The exact `ownershipPercentage` is set on the personal-info attestation.\n- `CONTROL_PERSON` — has significant management responsibility.\n\nA person can hold both roles.","example":["BENEFICIAL_OWNER"],"items":{"enum":["BENEFICIAL_OWNER","CONTROL_PERSON"],"type":"string"},"type":"array"}},"required":["relationships"],"type":"object"},"CreateBusinessComplianceReviewRequest":{"properties":{"tier":{"description":"Business review tier — Full (complete Know Your Business document set).","enum":["FULL"],"example":"FULL","type":"string"},"type":{"description":"Set to `business` for a business compliance review.","enum":["business"],"example":"business","type":"string"}},"required":["type","tier"],"type":"object"},"CreateBusinessComplianceReviewResponse":{"properties":{"id":{"description":"Unique review ID","format":"uuid","type":"string","x-order":1},"tier":{"description":"The tier this review is for.","enum":["US_STANDARD","FULL"],"example":"FULL","type":"string","x-order":2},"type":{"enum":["business"],"type":"string","x-order":3},"status":{"allOf":[{"$ref":"#/components/schemas/ComplianceReviewStatusDraft"}],"description":"Status of the compliance review immediately after creation. Always draft on a successful create.","x-order":4},"createdAt":{"description":"ISO 8601 timestamp when the review was created.","example":"2026-02-24T12:00:00.000Z","type":"string","x-order":5},"requiredAttestations":{"description":"Attestation types required to submit this review.","items":{"$ref":"#/components/schemas/AttestationRequirement"},"type":"array","x-order":6},"uploadedAttestations":{"description":"Attestations already uploaded for this review.","example":[],"items":{"$ref":"#/components/schemas/AttestationSummary"},"type":"array","x-order":7},"associatedPersons":{"description":"Associated persons (beneficial owners and the control person) for this business review. Up to four beneficial owners plus one control person, who may be the same individual as one of the beneficial owners.","items":{"$ref":"#/components/schemas/AssociatedPersonResource"},"type":"array","x-order":8}},"required":["id","tier","type","status","createdAt","requiredAttestations","uploadedAttestations","associatedPersons"],"type":"object"},"CreateCounterpartyRequestBody":{"properties":{"counterparty":{"oneOf":[{"$ref":"#/components/schemas/IndividualCounterpartyInfo","title":"Individual"},{"$ref":"#/components/schemas/BusinessCounterpartyInfo","title":"Business"}]}},"required":["counterparty"],"type":"object"},"CreateIndividualComplianceReviewRequest":{"properties":{"tier":{"description":"Individual review tier — Light (reduced KYC) or Standard.","enum":["LIGHT","STANDARD"],"example":"LIGHT","type":"string"},"type":{"description":"Set to `individual` for an individual compliance review.","enum":["individual"],"example":"individual","type":"string"}},"required":["type","tier"],"type":"object"},"CreateIndividualComplianceReviewResponse":{"properties":{"id":{"description":"Unique review ID","format":"uuid","type":"string","x-order":1},"tier":{"description":"The tier this review is for.","enum":["LIGHT","STANDARD"],"example":"LIGHT","type":"string","x-order":2},"type":{"enum":["individual"],"type":"string","x-order":3},"status":{"allOf":[{"$ref":"#/components/schemas/ComplianceReviewStatusDraft"}],"description":"Status of the compliance review immediately after creation. Always draft on a successful create.","x-order":4},"createdAt":{"description":"ISO 8601 timestamp when the review was created.","example":"2026-02-24T12:00:00.000Z","type":"string","x-order":5},"requiredAttestations":{"description":"Attestation types required to submit this review.","items":{"$ref":"#/components/schemas/AttestationRequirement"},"type":"array","x-order":6},"uploadedAttestations":{"description":"Attestations already uploaded for this review.","example":[],"items":{"$ref":"#/components/schemas/AttestationSummary"},"type":"array","x-order":7}},"required":["id","tier","type","status","createdAt","requiredAttestations","uploadedAttestations"],"type":"object"},"CreateMuralWebhookInput":{"properties":{"categories":{"description":"Event categories to subscribe to","example":["MURAL_ACCOUNT_BALANCE_ACTIVITY"],"items":{"enum":["MURAL_ACCOUNT_BALANCE_ACTIVITY","BUSINESS_VERIFICATION_STATUS","ORGANIZATION_TOS","PAYOUT_REQUEST","PAYIN","COMPLIANCE_REVIEW"],"type":"string"},"type":"array"},"url":{"description":"HTTPS URL endpoint where webhook events will be delivered","example":"https://api.example.com/webhooks","type":"string"}},"required":["url","categories"],"type":"object"},"CreatePayinResponse":{"properties":{"id":{"format":"uuid","type":"string","x-order":1},"destinationAccountId":{"description":"The ID of the mural account that the payin is being sent to.","format":"uuid","type":"string","x-order":2},"payinRail":{"description":"The payment rail used for this payin.","enum":["ACH","WIRE","SEPA","MXN_SPEI","BRL_PIX","ARS_CVU","COP_PSE","COP_BREB","BLOCKCHAIN"],"type":"string","x-order":3},"payinStatus":{"description":"The status of the payin.","oneOf":[{"$ref":"#/components/schemas/PayinCreatedStatus","title":"Payin Created Status"},{"$ref":"#/components/schemas/PayinCanceledStatus","title":"Payin Canceled Status"},{"$ref":"#/components/schemas/PayinPendingStatus","title":"Payin Pending Status"},{"$ref":"#/components/schemas/PayinOnHoldStatus","title":"Payin On Hold Status"},{"$ref":"#/components/schemas/PayinCompletedStatus","title":"Payin Completed Status"},{"$ref":"#/components/schemas/PayinFailedStatus","title":"Payin Failed Status"}],"x-order":4},"sourceAmount":{"description":"The amount sent by the payer, in the source currency.","example":{"currencySymbol":"USD","exponent":2,"type":"fiat","value":"10000"},"oneOf":[{"$ref":"#/components/schemas/PayinFiatAmount","title":"Fiat"},{"$ref":"#/components/schemas/PayinSourceBlockchainAmount","title":"Blockchain"}],"x-order":5},"settlementStrategy":{"description":"The settlement strategy applied to this payin — whether funds are held as a fiat balance in the account or automatically converted to the Account's destination token on settlement.","oneOf":[{"$ref":"#/components/schemas/HoldInFiatSettlementStrategy","title":"Hold In Fiat"},{"$ref":"#/components/schemas/AutoOnrampSettlementStrategy","title":"Auto On-Ramp"}],"x-order":6},"settlementDetails":{"description":"Where the funds are going (pre-settlement) or landed (post-settlement).","oneOf":[{"$ref":"#/components/schemas/FiatSettlementDetails","title":"Fiat"},{"$ref":"#/components/schemas/BlockchainSettlementDetails","title":"Blockchain"}],"x-order":7},"fees":{"allOf":[{"$ref":"#/components/schemas/PayinFees"}],"description":"Breakdown of all fees applied to this payin.","x-order":8},"payinInstructions":{"description":"The instructions for the payin intent.","oneOf":[{"$ref":"#/components/schemas/COPCreatePayinInstructions","title":"COP PSE Create Payin Instructions"},{"$ref":"#/components/schemas/COPBreBPayinInstructions","title":"COP Bre-B Payin Instructions"},{"$ref":"#/components/schemas/ARSBankTransferPayinInstructions","title":"ARS Bank Transfer Payin Instructions"},{"$ref":"#/components/schemas/BRLPixPayinInstructions","title":"BRL Pix Payin Instructions"},{"$ref":"#/components/schemas/MXNSpeiPayinInstructions","title":"MXN SPEI Payin Instructions"}],"x-order":9},"exchangeRate":{"description":"The exchange rate used for this payin. Multiply the fiat payin amount by this rate to get the equivalent token amount. Only present for non-USD payins.","type":"number","x-order":10},"createdAt":{"description":"The date and time the payin was created.","format":"date-time","type":"string","x-order":11},"updatedAt":{"description":"The date and time the payin was last updated.","format":"date-time","type":"string","x-order":12},"payinBatchId":{"description":"If this payin was created as part of a batch payin, the ID of the PayinBatch.","format":"uuid","nullable":true,"type":"string","x-order":13}},"required":["id","destinationAccountId","payinRail","payinStatus","sourceAmount","settlementStrategy","settlementDetails","fees","createdAt","updatedAt"],"type":"object"},"CreatePayoutMethodRequestBody":{"properties":{"alias":{"description":"Internal user-friendly alias name for this payout method","type":"string"},"payoutMethod":{"description":"The payout method details for this counterparty","oneOf":[{"$ref":"#/components/schemas/USDPayoutMethod","title":"USD"},{"$ref":"#/components/schemas/ARSPayoutMethod","title":"ARS"},{"$ref":"#/components/schemas/BRLPayoutMethod","title":"BRL"},{"$ref":"#/components/schemas/COPPayoutMethod","title":"COP"},{"$ref":"#/components/schemas/EURPayoutMethod","title":"EUR"},{"$ref":"#/components/schemas/MXNPayoutMethod","title":"MXN"},{"$ref":"#/components/schemas/CLPPayoutMethod","title":"CLP"},{"$ref":"#/components/schemas/PENPayoutMethod","title":"PEN"},{"$ref":"#/components/schemas/BOBPayoutMethod","title":"BOB"},{"$ref":"#/components/schemas/CRCPayoutMethod","title":"CRC"},{"$ref":"#/components/schemas/ZARPayoutMethod","title":"ZAR"},{"$ref":"#/components/schemas/BlockchainPayoutMethodDetails","description":"Blockchain wallet details, the receiving token will be the same used to create the payout request, and the blockchain network needs to be the same one from the account used to create the payout request","title":"Blockchain Wallet"}]}},"required":["alias","payoutMethod"],"type":"object"},"CvuPayinAmount":{"properties":{"currencySymbol":{"enum":["ARS"],"type":"string"},"value":{"description":"The amount in cents (e.g., \"2500\" represents 25.00).","example":"2500","type":"string"}},"required":["value","currencySymbol"],"type":"object"},"CvuPayinRail":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/CvuPayinAmount"}],"description":"The amount to simulate. Must be denominated in ARS."},"type":{"enum":["cvu"],"type":"string"}},"required":["type","amount"],"type":"object"},"DepositAccount":{"properties":{"bankAccountNumber":{"type":"string"},"bankAddress":{"type":"string"},"bankBeneficiaryAddress":{"type":"string"},"bankBeneficiaryName":{"type":"string"},"bankName":{"type":"string"},"bankRoutingNumber":{"type":"string"},"currency":{"enum":["USD","COP","ARS","EUR","MXN","BRL","CLP","PEN","BOB","CRC","ZAR"],"type":"string"},"id":{"format":"uuid","type":"string"},"paymentRails":{"items":{"enum":["ACH","WIRE","ACH_PUSH","ACH_PULL","FEDNOW","NON_US_LOCAL","SWIFT","COP_PSE","COP_BREB","CRYPTO_DEPOSIT","MXN_SPEI","BRL_PIX","ARS_CVU"],"type":"string"},"type":"array"},"status":{"enum":["ACTIVATED","DEACTIVATED"],"type":"string"}},"required":["id","status","currency","bankBeneficiaryName","bankBeneficiaryAddress","bankName","bankAddress","bankRoutingNumber","bankAccountNumber","paymentRails"],"type":"object"},"DepositAwaitingFundsStatus":{"properties":{"type":{"enum":["awaitingFunds"],"type":"string"}},"required":["type"],"type":"object"},"DepositCompletedStatus":{"properties":{"completedAt":{"description":"The date when the deposit was completed","format":"date-time","type":"string"},"initiatedAt":{"description":"The date when the deposit was initiated","format":"date-time","type":"string"},"type":{"enum":["completed"],"type":"string"}},"required":["type","initiatedAt","completedAt"],"type":"object"},"DepositMetadata":{"properties":{"details":{"description":"The deposit details","oneOf":[{"$ref":"#/components/schemas/FiatDepositMetadata","title":"Fiat"},{"$ref":"#/components/schemas/BlockchainDepositMetadata","title":"Blockchain"}]},"type":{"enum":["deposit"],"type":"string"}},"required":["type","details"],"type":"object"},"DeveloperFee":{"properties":{"developerFeePercentage":{"type":"number"}},"type":"object"},"DocumentResponse":{"properties":{"createdAt":{"description":"Created time","example":"2023-01-01T00:00:00Z","format":"date-time","title":"Created Time","type":"string"},"documentStatus":{"description":"Document status","example":{"type":"pending"},"oneOf":[{"$ref":"#/components/schemas/DocumentStatusInactive"},{"$ref":"#/components/schemas/DocumentStatusPending"},{"$ref":"#/components/schemas/DocumentStatusComplete"},{"$ref":"#/components/schemas/DocumentStatusError"}],"title":"Document Status"},"documentType":{"description":"Document type","example":"GOVERNMENT_ID","title":"Document Type","type":"string"},"fileName":{"description":"Document filename","example":"government_id.pdf","title":"File Name","type":"string"},"id":{"description":"Document identifier","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid","title":"Document ID","type":"string"},"updatedAt":{"description":"Updated time","example":"2023-01-01T00:00:00Z","format":"date-time","title":"Updated Time","type":"string"}},"required":["id","fileName","documentStatus","documentType","createdAt","updatedAt"],"type":"object"},"DocumentStatusComplete":{"description":"Indicates the KYC document has been completed","properties":{"approvedAt":{"description":"The time the KYC document status has been approved","example":"2023-01-01T00:00:00Z","format":"date-time","title":"Approved Time","type":"string"},"type":{"enum":["complete"],"type":"string"}},"required":["type","approvedAt"],"type":"object"},"DocumentStatusError":{"description":"Indicates there was an error during KYC document processing","properties":{"details":{"description":"The details of the error that occurred during KYC document processing","example":"File failed address verification","title":"Error Details","type":"string"},"erroredAt":{"description":"The time the KYC document status has errored","example":"2023-01-01T00:00:00Z","format":"date-time","title":"Errored Time","type":"string"},"type":{"enum":["error"],"type":"string"}},"required":["type","details","erroredAt"],"type":"object"},"DocumentStatusInactive":{"description":"Indicates the KYC document is inactive","properties":{"type":{"enum":["inactive"],"type":"string"}},"required":["type"],"type":"object"},"DocumentStatusPending":{"description":"Indicates the KYC document is pending","properties":{"type":{"enum":["pending"],"type":"string"}},"required":["type"],"type":"object"},"DocumentUpload":{"properties":{"documentContent":{"description":"**Supporting Document**\n\nA base64 encoded file showing the purpose for the payout.\n\n- **Format**: Base64 encoded data URI. File size must be less than 10MB.\n- **Supported formats**: PDF, JPEG, JPG, PNG, CSV\n- **Note**: See Supporting Details Requirements for information on when this is required.","title":"Document Content","type":"string"},"documentType":{"description":"Document type","enum":["GOVERNMENT_ID","GOVERNMENT_ID_BACK","PROOF_OF_ADDRESS","BUSINESS_LICENSE","ARTICLES_OF_INCORPORATION","SHAREHOLDER_REGISTRY","FLOW_OF_FUNDS","BANK_STATEMENT","OWNERSHIP_STRUCTURE","UTILITY_BILL","TAX_DOCUMENT","OTHER","SELFIE_PHOTO","GOVERNMENT_ISSUED_LETTER","CRYPTO_DIGITAL_ASSETS","EMPLOYMENT_INCOME","INHERITANCE_GIFT","INVESTMENTS_DIVIDENDS","LOANS_CREDIT_FACILITIES","OTHER_VERIFIED_SOURCES","PENSION_SOCIAL_BENEFITS","SALE_OF_ASSETS","SAVINGS_ACCUMULATED_FUNDS","SELF_EMPLOYMENT_BUSINESS_INCOME"],"title":"Document Type","type":"string"},"filename":{"description":"Document filename with extension","title":"Document Filename","type":"string"}},"required":["filename","documentType","documentContent"],"type":"object"},"DriverLicenseGovernmentId":{"description":"Driver license - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Driver License Issuer (ISO 3166-1 alpha-2)","example":"US","title":"Country Code","type":"string"},"driverLicenseBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of driver license document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"drivers_license_back.pdf"},"title":"Driver License Back Document"},"driverLicenseFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of driver license document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"drivers_license_front.pdf"},"title":"Driver License Front Document"},"driverLicenseNumber":{"description":"Driver License Number","example":"D12345678","title":"Driver License Number","type":"string"},"type":{"enum":["driverLicense"],"type":"string"}},"required":["type","driverLicenseNumber","countryCode","driverLicenseFrontDocument","driverLicenseBackDocument"],"type":"object"},"DriverLicenseIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"US","type":"string"},"driverLicenseBackDocumentId":{"description":"File ID (UUID) of the back of the driver license, from the document upload endpoint.","format":"uuid","type":"string"},"driverLicenseFrontDocumentId":{"description":"File ID (UUID) of the front of the driver license, from the document upload endpoint.","format":"uuid","type":"string"},"driverLicenseNumber":{"description":"Driver's license number","example":"D1234567","type":"string"},"type":{"enum":["driverLicense"],"type":"string"}},"required":["type","countryCode","driverLicenseNumber","driverLicenseFrontDocumentId","driverLicenseBackDocumentId"],"title":"Driver's License","type":"object"},"EURDeveloperFee":{"properties":{"developerFeePercentage":{"description":"Developer fee percentage for EUR payins (0-100)","example":1.8,"maximum":100,"minimum":0,"type":"number"},"type":{"enum":["eur"],"type":"string"}},"required":["type","developerFeePercentage"],"type":"object"},"EURPayinRailDetails":{"properties":{"accountHolderName":{"type":"string"},"bankAddress":{"type":"string"},"bankName":{"type":"string"},"bic":{"type":"string"},"currency":{"enum":["EUR"],"type":"string"},"iban":{"type":"string"},"payinRail":{"enum":["SEPA"],"type":"string"},"type":{"enum":["eur"],"type":"string"}},"required":["type","currency","payinRail","bankName","bankAddress","accountHolderName","iban","bic"],"type":"object"},"EURPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/EURSepaPayoutMethodDetails","title":"EUR SEPA"}]},"type":{"enum":["eur"],"type":"string"}},"required":["type","details"],"type":"object"},"EURPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/EURSepaPayoutMethodResponseDetails","title":"EUR SEPA"}]},"type":{"enum":["eur"],"type":"string"}},"required":["type","details"],"type":"object"},"EURSepaPayoutMethodDetails":{"properties":{"bankName":{"type":"string"},"country":{"format":"alpha2 codes","type":"string"},"iban":{"type":"string"},"swiftBic":{"type":"string"},"symbol":{"enum":["EUR"],"type":"string"},"type":{"enum":["eurSepa"],"type":"string"}},"required":["type","symbol","iban","swiftBic","country","bankName"],"type":"object"},"EURSepaPayoutMethodResponseDetails":{"properties":{"bankName":{"type":"string"},"country":{"format":"alpha2 codes","type":"string"},"ibanTruncated":{"description":"Masked IBAN (format: ****1234)","example":"****3000","type":"string"},"swiftBicTruncated":{"description":"Masked SWIFT/BIC code (format: ****1234)","example":"****DEFF","type":"string"},"symbol":{"enum":["EUR"],"type":"string"},"type":{"enum":["eurSepa"],"type":"string"}},"required":["type","symbol","country","bankName","ibanTruncated","swiftBicTruncated"],"type":"object"},"EmailFilter":{"description":"Filter based on the email of the Organization","properties":{"email":{"description":"The email of the Organization to filter by. This will be case insensitive and will match any organization that contains the filter value.","type":"string"},"type":{"enum":["email"],"type":"string"}},"required":["type","email"],"type":"object"},"Enabled":{"description":"Indicates the currency is enabled for use with your Mural account","properties":{"type":{"enum":["enabled"],"type":"string"}},"required":["type"],"type":"object"},"EurDetails":{"properties":{"country":{"description":"Bank account country.","format":"alpha2 codes","type":"string"},"iban":{"description":"The International Bank Account Number (IBAN) of the recipient","type":"string"},"swiftBic":{"description":"The SWIFT / Bank Identifier Code (BIC) of the recipient","type":"string"},"symbol":{"enum":["EUR"],"type":"string"},"type":{"enum":["eur"],"type":"string"}},"required":["type","symbol","iban","swiftBic","country"],"type":"object"},"ExecuteEndUserCustodialMuralTransferRequestInput":{"properties":{"exchangeRateToleranceMode":{"default":"FLEXIBLE","description":"Exchange rate checking behavior for payout execution. FLEXIBLE: Execute the payout regardless of exchange rate changes. STRICT: Fail with PayoutQuoteExpiredException if rates have changed (see Errors section in documentation).","enum":["STRICT","FLEXIBLE"],"type":"string"},"signature":{"description":"The signature to authorize the payout execution.","example":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","type":"string"}},"required":["signature"],"type":"object"},"ExecutePayoutRequestInput":{"properties":{"exchangeRateToleranceMode":{"default":"FLEXIBLE","description":"Exchange rate checking behavior for payout execution. FLEXIBLE: Execute the payout regardless of exchange rate changes. STRICT: Fail with PayoutQuoteExpiredException if rates have changed (see Errors section in documentation).","enum":["STRICT","FLEXIBLE"],"type":"string"}},"type":"object"},"ExternalPayoutMetadata":{"description":"External payout made outside of the platform","properties":{"recipientWalletAddress":{"description":"The recipient address","example":"0x0000000000000000000000000000000000000000","format":"address","type":"string"},"type":{"enum":["externalPayout"],"type":"string"}},"required":["type","recipientWalletAddress"],"type":"object"},"FiatAmount":{"properties":{"type":{"enum":["fiat"],"type":"string","x-order":1},"currencySymbol":{"description":"The ISO 4217 currency code.","enum":["USD"],"type":"string","x-order":2},"exponent":{"description":"The number of decimal places used by the smallest unit of the currency.","example":2,"type":"number","x-order":3},"value":{"description":"The amount in the smallest unit of the currency, as a string to preserve precision (e.g., for USD with exponent 2, \"2500\" represents $25.00).","example":"2500","type":"string","x-order":4}},"required":["type","currencySymbol","exponent","value"],"type":"object"},"FiatDepositMetadata":{"properties":{"createdAt":{"description":"The deposit creation date","format":"date-time","type":"string"},"depositId":{"description":"The deposit ID","format":"uuid","type":"string"},"depositStatusInfo":{"description":"The deposit status info","oneOf":[{"$ref":"#/components/schemas/DepositAwaitingFundsStatus","title":"Awaiting Funds"},{"$ref":"#/components/schemas/DepositCompletedStatus","title":"Completed"}]},"exchangeRate":{"description":"The exchange rate applied for this deposit. Multiply the fiat deposit amount by this rate to get the equivalent token amount. Only present for non-USD deposits.","type":"number"},"senderMetadata":{"description":"The sender metadata, if available.","oneOf":[{"$ref":"#/components/schemas/AchSenderMetadata","title":"ACH"},{"$ref":"#/components/schemas/WireSenderMetadata","title":"Wire"},{"$ref":"#/components/schemas/ArsCvuSenderMetadata","title":"ARS-CVU"},{"$ref":"#/components/schemas/BrlPixSenderMetadata","title":"BRL-PIX"},{"$ref":"#/components/schemas/MxnSpeiSenderMetadata","title":"MXN-SPEI"}]},"sentFiatAmount":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"The fiat amount sent"},"type":{"enum":["fiat"],"type":"string"}},"required":["type","depositId","createdAt","sentFiatAmount","depositStatusInfo"],"type":"object"},"FiatPayout":{"description":"Details pertaining to a specific recipient's payout","properties":{"developerFee":{"allOf":[{"$ref":"#/components/schemas/DeveloperFee"}],"description":"The developer fee applied to this payout. The developer fee percentage applied to this payout and collected on your behalf. This fee percentage is applied to the source token amount at execution time."},"exchangeFeePercentage":{"description":"The total fee for the transaction (in percentile) applied at transaction execution time. This is applied to the source token amount. For example, a value of 3 means 3%.","type":"number"},"exchangeRate":{"description":"The exchange rate for the transaction. The rate at which the token amount will be converted to fiat. The units are destination fiat per token.","type":"number"},"feeTotal":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The total fee for the fiat payout"},"fiatAmount":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"The fiat amount to payout to the recipient"},"fiatAndRailCode":{"description":"The fiat and rail code, if applicable, for the payout. This corresponds to the type discriminator of the fiatAndRailDetails field in the payout request.","enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"},"fiatPayoutStatus":{"description":"The status of the fiat payout to the recipient. A successful payout will follow these statuses: created → pending → on-hold (optional) → completed. If a payout fails, it will transition to refundInProgress → refunded. A payout can be canceled before initiation, resulting in the canceled status. The failed status is deprecated and will be replaced by the refund flow.","oneOf":[{"$ref":"#/components/schemas/PayoutCreatedStatus","title":"Created"},{"$ref":"#/components/schemas/PayoutPendingStatus","title":"Pending"},{"$ref":"#/components/schemas/PayoutOnHoldStatus","title":"On Hold"},{"$ref":"#/components/schemas/PayoutCompletedStatus","title":"Completed"},{"$ref":"#/components/schemas/PayoutFailedStatus","deprecated":true,"title":"Failed"},{"$ref":"#/components/schemas/PayoutCanceledStatus","title":"Canceled"},{"$ref":"#/components/schemas/PayoutRefundInProgressStatus","title":"Refund In Progress"},{"$ref":"#/components/schemas/PayoutRefundedStatus","title":"Refunded"}]},"transactionFee":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The flat transaction fee for the fiat payout"},"type":{"enum":["fiat"],"type":"string"}},"required":["type","fiatAndRailCode","fiatPayoutStatus","fiatAmount","transactionFee","exchangeFeePercentage","exchangeRate","feeTotal"],"type":"object"},"FiatPayoutDetails":{"properties":{"bankAccountOwner":{"type":"string"},"bankName":{"type":"string"},"developerFee":{"allOf":[{"$ref":"#/components/schemas/DeveloperFee"}],"description":"This fee will be added to the base fees associated with this payout and it will be applied to the source token amount. It will be collected on your behalf and paid out to you at an agreed upon cadence. Reach out to the Mural support team to enable this feature."},"fiatAndRailDetails":{"description":"The fiat and rail details (if applicable) for the payout. This specifies the currency in which the fiat will be delivered.","oneOf":[{"$ref":"#/components/schemas/UsdDetails","title":"USD Details"},{"$ref":"#/components/schemas/CopDetails","title":"COP Details"},{"$ref":"#/components/schemas/CopBreBDetails","title":"COP BRE-B Details"},{"$ref":"#/components/schemas/ArsDetails","title":"ARS Details"},{"$ref":"#/components/schemas/EurDetails","title":"EUR Details"},{"$ref":"#/components/schemas/MxnDetails","title":"MXN Details"},{"$ref":"#/components/schemas/BrlDetails","title":"BRL Details"},{"$ref":"#/components/schemas/ClpDetails","title":"CLP Details"},{"$ref":"#/components/schemas/PenDetails","title":"PEN Details"},{"$ref":"#/components/schemas/BobDetails","title":"BOB Details"},{"$ref":"#/components/schemas/CrcDetails","title":"CRC Details"},{"$ref":"#/components/schemas/ZarDetails","title":"ZAR Details"},{"$ref":"#/components/schemas/UsdPeruDetails","title":"USD Peru Details"},{"$ref":"#/components/schemas/UsdChinaDetails","title":"USD China Details"},{"$ref":"#/components/schemas/UsdPanamaDetails","title":"USD Panama Details"},{"$ref":"#/components/schemas/UsdHongKongDetails","title":"USD Hong Kong Details"}]},"type":{"enum":["fiat"],"type":"string"}},"required":["type","bankName","bankAccountOwner","fiatAndRailDetails"],"type":"object"},"FiatPayoutFeeError":{"properties":{"fiatAndRailCode":{"description":"The currency and if applicable, rail, that the token will be converted to.","enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"},"message":{"description":"The error message explaining why the fee calculation failed","type":"string"},"reason":{"allOf":[{"$ref":"#/components/schemas/PayoutFeeErrorReason"}],"description":"Why the fee could not be quoted. Only a temporarily unavailable payout is worth retrying."},"tokenSymbol":{"description":"The token symbol you want to exchange for the fiat amount.","example":"USDC","type":"string"},"type":{"enum":["error"],"type":"string"}},"required":["type","message","reason","fiatAndRailCode","tokenSymbol"],"type":"object"},"FiatPayoutFeeSuccess":{"properties":{"estimatedTokenAmountRequired":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The estimated token amount required to purchase the fiat amount specified."},"exchangeFeePercentage":{"description":"The total fee for the transaction (in percentile) applied at transaction execution time. This is applied to the source token amount.","type":"number"},"exchangeRate":{"description":"The exchange rate for the transaction. The rate at which the token amount will be converted to fiat. The units are destination fiat per token.","type":"number"},"feeTotal":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The total fee for the fiat payout."},"fiatAmount":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"The estimated fiat amount you will receive."},"fiatAndRailCode":{"description":"The currency and if applicable, rail, that the token will be converted to.","enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"},"minTransactionValue":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The minimum value for the transaction, if applicable."},"transactionFee":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The expected, flat transaction fee applied to the payout"},"type":{"enum":["success"],"type":"string"}},"required":["exchangeRate","exchangeFeePercentage","fiatAndRailCode","transactionFee","type","estimatedTokenAmountRequired","fiatAmount","feeTotal"],"type":"object"},"FiatSettlementDetails":{"description":"Funds settle as a fiat balance on the destination account.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/FiatAmount"}],"description":"The expected (pre-settlement) or actual (post-settlement) fiat amount credited to the account.","example":{"currencySymbol":"USD","exponent":2,"type":"fiat","value":"9825"}},"type":{"enum":["fiat"],"type":"string"}},"required":["type","amount"],"type":"object"},"FiatSourceCurrency":{"description":"A fiat source currency to debit (e.g. USD-funded payouts).","properties":{"fiatCurrencyCode":{"description":"The fiat currency to debit.","enum":["USD"],"example":"USD","type":"string"},"type":{"enum":["fiat"],"type":"string"}},"required":["type","fiatCurrencyCode"],"type":"object"},"FlowOfFundsDocumentReference":{"properties":{"documentType":{"description":"The type of flow-of-funds document","enum":["FLOW_OF_FUNDS","BANK_STATEMENT"],"example":"FLOW_OF_FUNDS","type":"string","x-order":1},"documentId":{"description":"The document ID returned by the document upload endpoint after a successful upload.","format":"uuid","type":"string","x-order":2}},"required":["documentType","documentId"],"type":"object"},"ForeignIdGovernmentId":{"description":"Foreign ID - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Foreign ID Issuer (ISO 3166-1 alpha-2)","example":"CO","title":"Country Code","type":"string"},"foreignIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of foreign ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"foreign_id_back.pdf"},"title":"Foreign ID Back Document"},"foreignIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of foreign ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"foreign_id_front.pdf"},"title":"Foreign ID Front Document"},"foreignIdNumber":{"description":"Foreign ID Number","example":"FID12345678","title":"Foreign ID Number","type":"string"},"type":{"enum":["foreignId"],"type":"string"}},"required":["type","foreignIdNumber","countryCode","foreignIdFrontDocument","foreignIdBackDocument"],"type":"object"},"ForeignIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"ES","type":"string"},"foreignIdBackDocumentId":{"description":"File ID (UUID) of the back of the foreign ID, from the document upload endpoint.","format":"uuid","type":"string"},"foreignIdFrontDocumentId":{"description":"File ID (UUID) of the front of the foreign ID, from the document upload endpoint.","format":"uuid","type":"string"},"foreignIdNumber":{"description":"Foreign ID number","example":"X1234567A","type":"string"},"type":{"enum":["foreignId"],"type":"string"}},"required":["type","countryCode","foreignIdNumber","foreignIdFrontDocumentId","foreignIdBackDocumentId"],"title":"Foreign ID","type":"object"},"FormationDocumentReference":{"properties":{"documentType":{"description":"The type of formation document","enum":["ARTICLES_OF_INCORPORATION","BUSINESS_LICENSE","OTHER"],"example":"ARTICLES_OF_INCORPORATION","type":"string","x-order":1},"documentId":{"description":"The document ID returned by the document upload endpoint after a successful upload.","format":"uuid","type":"string","x-order":2}},"required":["documentType","documentId"],"type":"object"},"GeneralBankAccountDetails":{"description":"General bank account information for inline fiat payouts","properties":{"bankName":{"description":"The name of the bank","type":"string"},"fiatCurrencyCode":{"description":"The fiat currency code for this bank account","enum":["USD","COP","ARS","EUR","MXN","BRL","CLP","PEN","BOB","CRC","ZAR"],"type":"string"},"truncatedBankAccountNumber":{"description":"Truncated bank account number for privacy (format: ****1234)","example":"****1234","type":"string"}},"required":["fiatCurrencyCode","bankName","truncatedBankAccountNumber"],"type":"object"},"GenerateUploadUrlRequest":{"properties":{"contentType":{"description":"The MIME type of the document","enum":["image/jpeg","image/jpg","image/png","application/pdf"],"example":"application/pdf","type":"string"},"filename":{"description":"Human-readable filename for the document","example":"passport_scan.pdf","type":"string"}},"required":["filename","contentType"],"type":"object"},"GenerateUploadUrlResponse":{"properties":{"documentId":{"description":"Unique identifier for the document. Use this ID to reference the document in subsequent API calls.","format":"uuid","type":"string"},"expiresAt":{"description":"Timestamp when the presigned upload URL expires.","format":"date-time","type":"string"},"uploadUrl":{"description":"The URL to send the multipart/form-data POST request to.","type":"string"},"uploadUrlFormFields":{"description":"Key-value pairs that must be included as form fields in the multipart POST request. The file field must be the last field in the request. These fields carry the upload signature and policy.","example":{"Content-Type":"application/pdf","Policy":"<base64-encoded policy>","X-Amz-Algorithm":"AWS4-HMAC-SHA256","X-Amz-Credential":"AKIA.../us-east-1/s3/aws4_request","X-Amz-Date":"20260409T120000Z","X-Amz-Signature":"<signature>","bucket":"my-bucket","key":"documents/org-id/doc-id/filename.pdf"},"type":"object"}},"required":["documentId","uploadUrl","uploadUrlFormFields","expiresAt"],"type":"object"},"GetMuralOrganizationRequestInfo":{"properties":{"filter":{"description":"Filter for organizations. See the filter type for more details. An empty filter will result in all Organizations being returned.","oneOf":[{"$ref":"#/components/schemas/NameFilter"},{"$ref":"#/components/schemas/EmailFilter"}]}},"type":"object"},"GetPayinExchangeRateRequest":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"The amount of the payin in the fiat currency"},"destinationToken":{"allOf":[{"$ref":"#/components/schemas/TokenWithBlockchain"}],"description":"The destination token that you want to receive in your mural account"}},"required":["destinationToken","amount"],"type":"object"},"GetPayoutFiatFeeInput":{"properties":{"fiatAmount":{"description":"The fiat amount you want to receive.","type":"number"},"fiatAndRailCode":{"description":"The currency and if applicable, rail, that will be converted to.","enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"},"tokenSymbol":{"description":"The token symbol you would be converting from","example":"USDC","type":"string"}},"required":["fiatAmount","tokenSymbol","fiatAndRailCode"],"type":"object"},"GetPayoutFiatFeesInput":{"properties":{"fiatFeeRequests":{"description":"A specific fiat-to-token payout instance for which we will calculate the fees.","items":{"$ref":"#/components/schemas/GetPayoutFiatFeeInput"},"type":"array"}},"required":["fiatFeeRequests"],"type":"object"},"GetPayoutTokenFeeInput":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The token amount you want to send."},"fiatAndRailCode":{"description":"The currency and if applicable, rail, that the token will be converted to.","enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"}},"required":["amount","fiatAndRailCode"],"type":"object"},"GetPayoutTokenFeesInput":{"properties":{"tokenFeeRequests":{"description":"A specific token-to-fiat payout instance for which we will calculate the fees.","items":{"$ref":"#/components/schemas/GetPayoutTokenFeeInput"},"type":"array"}},"required":["tokenFeeRequests"],"type":"object"},"GovernmentIdBackDocumentUpload":{"properties":{"documentContent":{"description":"**Government ID Back Document**\n\nA base64 encoded image or PDF of the back of the government ID.\n\n- **Format**: Base64 encoded data URI. File size must be less than 10MB.\n- **Supported formats**: PDF, JPEG, JPG, PNG","title":"Document Content","type":"string"},"filename":{"description":"Document filename with extension","title":"Document Filename","type":"string"}},"required":["filename","documentContent"],"type":"object"},"GovernmentIdFrontDocumentUpload":{"properties":{"documentContent":{"description":"**Government ID Front Document**\n\nA base64 encoded image or PDF of the front of the government ID.\n\n- **Format**: Base64 encoded data URI. File size must be less than 10MB.\n- **Supported formats**: PDF, JPEG, JPG, PNG","title":"Document Content","type":"string"},"filename":{"description":"Document filename with extension","title":"Document Filename","type":"string"}},"required":["filename","documentContent"],"type":"object"},"HealthInsuranceCardGovernmentId":{"description":"Health insurance card - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Health Insurance Card Issuer (ISO 3166-1 alpha-2)","example":"CA","title":"Country Code","type":"string"},"healthInsuranceCardBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of health insurance card document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"health_card_back.pdf"},"title":"Health Insurance Card Back Document"},"healthInsuranceCardFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of health insurance card document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"health_card_front.pdf"},"title":"Health Insurance Card Front Document"},"healthInsuranceCardNumber":{"description":"Health Insurance Card Number","example":"HIC12345678","title":"Health Insurance Card Number","type":"string"},"type":{"enum":["healthInsuranceCard"],"type":"string"}},"required":["type","healthInsuranceCardNumber","countryCode","healthInsuranceCardFrontDocument"],"type":"object"},"HealthInsuranceCardIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"CA","type":"string"},"healthInsuranceCardBackDocumentId":{"description":"File ID (UUID) of the back of the health insurance card, from the document upload endpoint.","format":"uuid","type":"string"},"healthInsuranceCardFrontDocumentId":{"description":"File ID (UUID) of the front of the health insurance card, from the document upload endpoint.","format":"uuid","type":"string"},"healthInsuranceCardNumber":{"description":"Health insurance card number","example":"H1234567890","type":"string"},"type":{"enum":["healthInsuranceCard"],"type":"string"}},"required":["type","countryCode","healthInsuranceCardNumber","healthInsuranceCardFrontDocumentId","healthInsuranceCardBackDocumentId"],"title":"Health Insurance Card","type":"object"},"HoldInFiatSettlementStrategy":{"description":"Funds were held as a fiat balance on the destination account with no conversion to the destination token.","properties":{"type":{"enum":["holdInFiat"],"type":"string"}},"required":["type"],"type":"object"},"IndividualComplianceReviewResponse":{"properties":{"id":{"description":"Unique review ID","format":"uuid","type":"string","x-order":1},"tier":{"description":"The tier this review is for.","enum":["LIGHT","STANDARD"],"example":"LIGHT","type":"string","x-order":2},"type":{"enum":["individual"],"type":"string","x-order":3},"status":{"description":"Current status of the compliance review.","oneOf":[{"$ref":"#/components/schemas/ComplianceReviewStatusDraft","title":"Draft"},{"$ref":"#/components/schemas/ComplianceReviewStatusSubmitted","title":"Submitted"},{"$ref":"#/components/schemas/ComplianceReviewStatusValidatingSubmission","title":"Validating Submission"},{"$ref":"#/components/schemas/ComplianceReviewStatusSubmissionValidationsFailed","title":"Submission Validations Failed"},{"$ref":"#/components/schemas/ComplianceReviewStatusInReview","title":"In Review"},{"$ref":"#/components/schemas/ComplianceReviewStatusAdditionalInformationRequested","title":"Additional Information Requested"},{"$ref":"#/components/schemas/ComplianceReviewStatusApproved","title":"Approved"},{"$ref":"#/components/schemas/ComplianceReviewStatusRejected","title":"Rejected"},{"$ref":"#/components/schemas/ComplianceReviewStatusError","title":"Error"}],"x-order":4},"createdAt":{"description":"ISO 8601 timestamp when the review was created.","example":"2026-02-24T12:00:00.000Z","type":"string","x-order":5},"requiredAttestations":{"description":"Attestation types required to submit this review.","items":{"$ref":"#/components/schemas/AttestationRequirement"},"type":"array","x-order":6},"uploadedAttestations":{"description":"Attestations already uploaded for this review.","example":[],"items":{"$ref":"#/components/schemas/AttestationSummary"},"type":"array","x-order":7}},"required":["id","tier","type","status","createdAt","requiredAttestations","uploadedAttestations"],"type":"object"},"IndividualContactInfoAttestation":{"properties":{"type":{"enum":["individualContactInfo"],"type":"string","x-order":1},"email":{"description":"Individual's email address","example":"jane.doe@example.com","type":"string","x-order":2},"phoneNumber":{"description":"Individual's phone number, including country code (e.g. +14155551234)","example":"+14155551234","type":"string","x-order":3}},"required":["type","email","phoneNumber"],"type":"object"},"IndividualCounterparty":{"properties":{"createdAt":{"type":"string"},"email":{"format":"email","type":"string"},"firstName":{"description":"The first name of the individual","type":"string"},"id":{"format":"uuid","type":"string"},"lastName":{"description":"The last name of the individual","type":"string"},"physicalAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressInput"}],"description":"The physical address of the individual counterparty."},"type":{"enum":["individual"],"type":"string"},"updatedAt":{"type":"string"}},"required":["type","id","createdAt","updatedAt","firstName","lastName","physicalAddress"],"type":"object"},"IndividualCounterpartyInfo":{"properties":{"email":{"description":"Email address for the counterparty. When provided, must be unique within the organization. Some destination rails (for example Colombian COP payouts) require an email on either the counterparty or its payout method — if missing for those rails, payout-method or payout-request creation will fail with `additional_counterparty_information_required` (counterparty endpoint) or `additional_recipient_information_required` (payout-request endpoint) listing the missing fields.","format":"email","type":"string"},"firstName":{"description":"The first name of the individual","type":"string"},"lastName":{"description":"The last name(s) of the individual","type":"string"},"physicalAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"The physical address of the individual counterparty."},"type":{"enum":["individual"],"type":"string"}},"required":["type","firstName","lastName","physicalAddress"],"type":"object"},"IndividualEEAInfoAttestation":{"properties":{"type":{"enum":["individualEeaInfo"],"type":"string","x-order":1},"placeOfBirthCountry":{"description":"Country of birth (ISO 3166-1 alpha-2 country code).","example":"FR","type":"string","x-order":2},"placeOfBirthCity":{"description":"City of birth.","example":"Paris","type":"string","x-order":3}},"required":["type","placeOfBirthCountry","placeOfBirthCity"],"type":"object"},"IndividualEndUserCustodialOrgRequest":{"properties":{"email":{"description":"The primary email address of the individual","type":"string"},"firstName":{"description":"The first name of the individual","type":"string"},"lastName":{"description":"The last name of the individual","type":"string"},"tosRelianceInfo":{"allOf":[{"$ref":"#/components/schemas/TOSRelianceInfo"}],"description":"Optional Terms of Service reliance information. TOS reliance must be enabled by the Mural technical team to use this field."},"type":{"enum":["endUserCustodialIndividual"],"type":"string"}},"required":["type","firstName","lastName","email"],"type":"object"},"IndividualEndUserCustodialOrganization":{"properties":{"approver":{"allOf":[{"$ref":"#/components/schemas/ThirdPartyUser"}],"description":"The approver of this organization"},"complianceInfo":{"allOf":[{"$ref":"#/components/schemas/OrganizationComplianceInfo"}],"description":"Compliance tier information for this organization."},"createdAt":{"format":"date-time","type":"string"},"currencyCapabilities":{"description":"The currencies that the individual organization can use to fund a Mural account or pay out from a Mural account","items":{"$ref":"#/components/schemas/MuralCurrencyCapability"},"type":"array"},"firstName":{"description":"The first name of the individual","type":"string"},"id":{"format":"uuid","type":"string"},"kycStatus":{"description":"The KYC verification status of the individual","oneOf":[{"$ref":"#/components/schemas/VerificationStatusInactive"},{"$ref":"#/components/schemas/VerificationStatusPending"},{"$ref":"#/components/schemas/VerificationStatusApproved"},{"$ref":"#/components/schemas/VerificationStatusError"},{"$ref":"#/components/schemas/VerificationStatusRejected"}]},"lastName":{"description":"The last name of the individual","type":"string"},"tosStatus":{"description":"The terms of service status of the individual","enum":["NOT_ACCEPTED","NEEDS_REVIEW","ACCEPTED"],"type":"string"},"type":{"enum":["endUserCustodialIndividual"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["type","id","createdAt","updatedAt","firstName","lastName","approver","tosStatus","kycStatus","currencyCapabilities","complianceInfo"],"type":"object"},"IndividualFinancialInfoAttestation":{"properties":{"type":{"enum":["individualFinancialInfo"],"type":"string","x-order":1},"sourceOfFunds":{"description":"Primary source of funds","enum":["COMPANY_FUNDS","ECOMMERCE_RESELLER","GAMBLING_PROCEEDS","GIFTS","GOVERNMENT_BENEFITS_TAX_REFUNDS","INHERITANCE","INVESTMENTS_LOANS","PENSION_RETIREMENT","SALARY","SALE_OF_ASSETS_REAL_ESTATE","SAVINGS","SOMEONE_ELSES_FUNDS"],"example":"SALARY","type":"string","x-order":2},"employmentStatus":{"description":"Individual's employment status","enum":["EMPLOYED","HOMEMAKER","RETIRED","SELF_EMPLOYED","STUDENT","UNEMPLOYED"],"example":"EMPLOYED","type":"string","x-order":3},"employer":{"description":"Employer name (required when employmentStatus is EMPLOYED)","example":"Acme Corp","type":"string","x-order":4},"latestOccupation":{"description":"Individual's latest occupation","enum":["ACCOMMODATION_AND_FOOD_SERVICE_MANAGER","ACCOUNTANT","ACCOUNTING_ASSOCIATE_PROFESSIONAL","ACCOUNTING_BOOKKEEPING_AND_ESTIMATING_CLERK","ACTOR","ACTUARIES_MATHEMATICIAN_AND_STATISTICIAN","ADMINISTRATIVE_AND_SPECIALIZED_SECRETARY","ADMINISTRATIVE_SERVICES_MANAGER","ADVERTISING_AND_PUBLIC_RELATIONS_MANAGER","AEROSPACE_ENGINEER","AGED_CARE_WORKER","AGRICULTURAL_AND_INDUSTRIAL_MACHINERY_MECHANIC_AND_REPAIRER","AGRICULTURAL_ENGINEER","AGRICULTURAL_FORESTRY_AND_FISHERY_LABOURER","AGRICULTURAL_FORESTRY_AND_FISHERY_PRODUCTS_OPERATOR","AGRICULTURAL_OR_INDUSTRIAL_MACHINERY_ASSEMBLER","AIRCRAFT_ENGINE_MECHANIC_AND_REPAIRER","AIRCRAFT_PILOT_AND_RELATED_ASSOCIATE_PROFESSIONAL","AIR_TRAFFIC_CONTROLLER","AIR_TRAFFIC_SAFETY_ELECTRONICS_TECHNICIAN","AQUACULTURE_WORKER","ARCHITECT","ARCHIVIST_AND_CURATOR","ARMED_FORCES_OCCUPATION","ART_DIRECTOR_AND_MEDIA_PRODUCER","ASSEMBLER","ASTRONOMERS_METEOROLOGIST_AND_GEOPHYSICIST","ATHLETE_AND_SPORTS_PLAYER","ATTENDANTS_PERSONAL_SERVICES_WORKER_AND_TRAVEL_GUIDE","AUTHOR_AND_RELATED_WRITER","AUTOMOTIVE_AND_SURFACE_CLEANING_WORKER","AVIATION_SERVICE_WORKER","BAKERS_PASTRY_COOK_AND_CONFECTIONERY_MAKER","BANK_TELLER_AND_RELATED_CLERK","BEVERAGE_PROCESSING_AND_RELATED_WORKER","BIOLOGICAL_SCIENTIST","BIOMEDICAL_ENGINEER","BLACKSMITHS_HAMMERSMITH_AND_FORGING_PRESS_WORKER","BOOKMAKERS_CROUPIER_AND_RELATED_GAMING_WORKER","BRANCH_MANAGER","BRICKLAYER_AND_RELATED_WORKER","BROADCASTING_AND_AUDIO_VISUAL_TECHNICIAN","BUILDING_AND_HOUSEKEEPING_SUPERVISOR","BUILDING_AND_RELATED_ELECTRICIAN","BUILDING_CARETAKER","BUILDING_FRAME_AND_RELATED_TRADES_WORKER","BUILDING_INSULATION_WORKER","BUILDING_STRUCTURE_CLEANER","BUSINESS_PROFESSIONAL","BUSINESS_SERVICES_AGENT","BUS_AND_TRAM_DRIVER","BUTCHERS_FISHMONGER_AND_RELATED_FOOD_PREPARER","CARPENTER_AND_JOINER","CARPET_FLOOR_AND_WALL_TILER","CAR_VAN_AND_MOTORCYCLE_DRIVER","CASHIER_AND_TICKET_CLERK","CHEMICAL_AND_PHYSICAL_SCIENCE_TECHNICIAN","CHEMICAL_ENGINEER","CHEMICAL_PROCESSING_PLANT_CONTROLLER","CHEMIST","CHIEF_EXECUTIVE_AND_MANAGING_DIRECTOR","CHILD_CARE_WORKER_AND_TEACHERS_AIDE","CHIMNEY_SWEEP_AND_RELATED_WORKER","CIVIL_ENGINEERING_TECHNICIAN","CIVIL_ENGINEER","CLEANER_AND_HELPER","CLINICAL_AND_DIAGNOSTIC_LABORATORY_TECHNICIAN","COOK","CREDIT_AND_LOANS_OFFICER","CROP_FARMER","DAIRY_AND_MILK_PRODUCTS_MACHINE_OPERATOR","DANCER_AND_CHOREOGRAPHER","DATABASE_AND_NETWORK_PROFESSIONAL","DATA_ENTRY_CLERK","DEBT_COLLECTOR_AND_RELATED_WORKER","DECORATOR_AND_COMMERCIAL_DESIGNER","DENTIST","DESIGNER","DIETITIAN_AND_NUTRITIONIST","DIRECTOR_AND_PRODUCER","DOMESTIC_CLEANER_AND_HELPER","DOORKEEPER_AND_RELATED_WORKER","DRAFTER","DRIVING_INSTRUCTOR","ECONOMICS_PROFESSOR","ECONOMIST","EDUCATION_MANAGER","EDUCATION_METHODS_SPECIALIST","ELECTROMECHANICAL_EQUIPMENT_ASSEMBLER","ELECTRONICS_ENGINEER","ELECTRONIC_ENGINEERING_TECHNICIAN","ELECTRONIC_EQUIPMENT_INSTALLER_AND_REPAIRER","ELEMENTARY_SCHOOL_TEACHER","EMBEDDED_SYSTEMS_ENGINEER","EMPLOYMENT_SERVICES_MANAGER","ENGINEERING_PROFESSIONAL","ENVIRONMENTAL_AND_OCCUPATIONAL_HEALTH_INSPECTOR","ENVIRONMENTAL_ENGINEER","ENVIRONMENTAL_PROTECTION_PROFESSIONAL","EVENT_PLANNER","EXCAVATING_AND_EARTHMOVING_EQUIPMENT_OPERATOR","FARM_EQUIPMENT_MECHANIC","FASHION_AND_OTHER_MODEL","FIBRE_PREPARING_SPINNING_AND_WINDING_MACHINE_OPERATOR","FILM_STAGE_AND_RELATED_DIRECTOR_AND_PRODUCER","FINANCE_MANAGER","FINANCIAL_ANALYST","FINANCIAL_AND_INSURANCE_SERVICES_BRANCH_MANAGER","FINANCIAL_SERVICES_MANAGER","FIRE_FIGHTER","FISHERY_WORKERS_HUNTER_AND_TRAPPER","FITNESS_AND_RECREATION_INSTRUCTOR_AND_PROGRAM_LEADER","FLIGHT_ATTENDANT_AND_TRAVEL_STEWARD","FLOOR_LAYER_AND_TILE_SETTER","FLORIST","FOOD_AND_RELATED_PRODUCTS_MACHINE_OPERATOR","FOOD_PREPARATION_ASSISTANT","FOOD_PROCESSING_AND_RELATED_TRADES_WORKER","FOOD_SERVICE_MANAGER","FORESTRY_AND_RELATED_WORKER","FORESTRY_TECHNICIAN","FREIGHT_HANDLER","FUNERAL_DIRECTOR_AND_EMBALMER","FURNITURE_FINISHER_AND_RELATED_WORKER","FUR_AND_LEATHER_PREPARING_MACHINE_OPERATOR","GARMENT_AND_RELATED_TRADES_WORKER","GAS_AND_WATER_OPERATIONS_ENGINEER","GENERAL_OFFICE_CLERK","GEOLOGIST_AND_GEOPHYSICIST","GLASS_MAKERS_CUTTERS_GRINDER_AND_FINISHER","GLAZIER","GRAIN_MILLER_AND_RELATED_WORKER","GRAPHIC_AND_MULTIMEDIA_DESIGNER","HAIRDRESSER","HANDICRAFT_WORKER","HAND_LAUNDERER_AND_PRESSER","HAND_PACKER","HEALTH_ASSOCIATE_PROFESSIONAL","HEALTH_CARE_ASSISTANT","HEALTH_PROFESSIONAL","HEALTH_SERVICES_MANAGER","HEAVY_TRUCK_AND_LORRY_DRIVER","HIGH_SCHOOL_TEACHER","HOME_BASED_PERSONAL_CARE_WORKER","HOSPITALITY_RETAIL_AND_OTHER_SERVICES_MANAGER","HOSPITAL_ORDERLY","HOTEL_AND_RESTAURANT_MANAGER","HOTEL_RECEPTIONIST","HOUSEKEEPER_AND_RELATED_WORKER","HUMAN_RESOURCES_SPECIALIST","HUMAN_RESOURCE_MANAGER","ICT_OPERATION_AND_USER_SUPPORT_TECHNICIAN","ICT_OPERATIONS_TECHNICIAN","ICT_SERVICE_MANAGER","ICT_USER_SUPPORT_TECHNICIAN","ILLUSTRATOR_AND_GRAPHIC_DESIGNER","IMAGE_AND_SOUND_RECORDING_EQUIPMENT_OPERATOR","INCINERATOR_AND_WATER_TREATMENT_PLANT_OPERATOR","INDUSTRIAL_AND_PRODUCTION_ENGINEER","INFORMATION_AND_COMMUNICATIONS_TECHNOLOGY_SERVICE_MANAGER","INFORMATION_CLERK","INFORMATION_SERVICES_MANAGER","INSURANCE_REPRESENTATIVE","INTERIOR_DESIGNER_AND_DECORATOR","JEWELLERY_AND_PRECIOUS_METAL_WORKER","JUDGE","KEYBOARD_OPERATOR","KITCHEN_HELPER","LAUNDRY_MACHINE_OPERATOR","LAWYER","LEGAL_PROFESSIONAL","LEGAL_SECRETARY","LEGISLATOR_AND_SENIOR_OFFICIAL","LIBRARIAN_AND_RELATED_INFORMATION_PROFESSIONAL","LIBRARY_CLERK","LIFE_SCIENCE_TECHNICIAN","LIVESTOCK_AND_DAIRY_PRODUCER","LIVESTOCK_FARMER","LODGING_HOUSEKEEPING_AND_RESTAURANT_SERVICES_WORKER","LOGGING_AND_FORESTRY_LABOURER","LOGISTICIAN_AND_RELATED_PROFESSIONAL","MACHINE_TOOL_OPERATOR","MAIL_CARRIER_AND_SORTING_CLERK","MANAGEMENT_AND_ORGANIZATION_ANALYST","MANAGING_DIRECTOR_AND_CHIEF_EXECUTIVE","MANUFACTURING_LABOURER","MANUFACTURING_MANAGER","MARKETING_AND_SALES_MANAGER","MARKETING_PROFESSIONAL","MARKET_GARDENER_AND_CROP_GROWER","MARKET_ORIENTED_ANIMAL_PRODUCER","MARKET_ORIENTED_SKILLED_AGRICULTURAL_WORKER","MATHEMATICIANS_ACTUARY_AND_STATISTICIAN","MEAT_FISH_AND_RELATED_FOOD_PREPARER","MECHANICAL_ENGINEERING_TECHNICIAN","MECHANICAL_ENGINEER","MECHANICAL_MACHINERY_ASSEMBLER","MEDICAL_AND_DENTAL_PROSTHETIC_TECHNICIAN","MEDICAL_AND_PHARMACEUTICAL_SALES_REPRESENTATIVE","MEDICAL_DIAGNOSTIC_AND_TREATMENT_TECHNICIAN","MEDICAL_DOCTOR","MEDICAL_EQUIPMENT_TECHNICIAN","MEDICAL_IMAGING_AND_THERAPEUTIC_EQUIPMENT_TECHNICIAN","MEDICAL_LABORATORY_TECHNICIAN","MEDICAL_RECORD_AND_HEALTH_INFORMATION_TECHNICIAN","METAL_FINISHING_PLATING_AND_COATING_MACHINE_OPERATOR","METAL_PROCESSING_PLANT_OPERATOR","METAL_WORKING_MACHINE_TOOL_SETTER_AND_OPERATOR","METEOROLOGIST","MIDWIFERY_AND_NURSING_PROFESSIONAL","MIDWIFERY_ASSOCIATE_PROFESSIONAL","MIDWIFE","MINERAL_AND_STONE_PROCESSING_PLANT_OPERATOR","MINING_AND_CONSTRUCTION_LABOURER","MINING_AND_METALLURGICAL_PROCESS_CONTROLLER","MINING_CONSTRUCTION_AND_MANUFACTURING_SUPERVISOR","MINING_ENGINEERS_METALLURGIST_AND_RELATED_PROFESSIONAL","MIXED_CROP_AND_LIVESTOCK_FARMER","MOBILE_PLANT_OPERATOR","MOTOR_VEHICLE_MECHANIC_AND_REPAIRER","MOTOR_VEHICLE_WINDOW_CLEANER_AND_RELATED_WORKER","MUSICIANS_SINGER_AND_COMPOSER","NUMERICAL_CLERK","NURSING_AND_MIDWIFERY_ASSOCIATE_PROFESSIONAL","NURSING_PROFESSIONAL","OCCUPATIONAL_HEALTH_AND_SAFETY_PROFESSIONAL","OFFICE_CLERK","OFFICE_MANAGER","OFFICE_SUPERVISOR","OPTICAL_AND_ELECTRONIC_EQUIPMENT_OPERATOR","OTHER","OTHER_AGRICULTURAL_FORESTRY_AND_FISHERY_WORKER","OTHER_ASSEMBLER","OTHER_BUSINESS_SERVICES_AGENT","OTHER_CLEANER","OTHER_CRAFT_AND_RELATED_WORKER","OTHER_EDUCATION_PROFESSIONAL","OTHER_ELEMENTARY_WORKER","OTHER_HANDICRAFT_WORKER","OTHER_HEALTH_PROFESSIONAL","OTHER_HEAVY_VEHICLE_AND_MOBILE_EQUIPMENT_MECHANIC_AND_REPAIRER","OTHER_INFORMATION_SERVICES_MANAGER","OTHER_LABOURER","OTHER_MACHINE_OPERATOR_AND_ASSEMBLER","OTHER_MANUFACTURING_MANAGER","OTHER_MINING_CONSTRUCTION_MANUFACTURING_AND_TRANSPORT_SUPERVISOR","OTHER_MOBILE_PLANT_OPERATOR","OTHER_PLANT_AND_MACHINE_OPERATOR","OTHER_PROCESS_CONTROL_TECHNICIAN","OTHER_PRODUCTION_AND_SPECIALIZED_SERVICES_MANAGER","OTHER_PRODUCTION_MANAGER","OTHER_PROFESSIONAL","OTHER_SALES_SUPPORT_WORKER","OTHER_SALES_WORKER","OTHER_SERVICES_MANAGER","OTHER_SHIP_AND_AIRCRAFT_CONTROLLER_AND_TECHNICIAN","OTHER_STATIONARY_PLANT_AND_MACHINE_OPERATOR","OTHER_TEACHING_PROFESSIONAL","OTHER_TECHNICIAN_AND_ASSOCIATE_PROFESSIONAL","OTHER_TRADER","OTHER_WORKER","PAINTERS_BUILDING_STRUCTURE_CLEANER_AND_RELATED_TRADES_WORKER","PARAMEDICAL_PRACTITIONER","PAYROLL_CLERK","PERSONAL_CARE_WORKER","PERSONAL_CARE_WORKERS_IN_HEALTH_SERVICE","PERSONAL_SERVICES_WORKER","PERSONNEL_CLERK","PEST_CONTROLLER_AND_FUMIGATOR","PETROLEUM_AND_NATURAL_GAS_REFINING_PLANT_OPERATOR","PHARMACEUTICAL_TECHNICIAN_AND_ASSISTANT","PHARMACIST","PHILOSOPHY_AND_RELIGION_PROFESSIONAL","PHOTOGRAPHER","PHYSICAL_AND_EARTH_SCIENCE_TECHNICIAN","PHYSICAL_AND_ENGINEERING_SCIENCE_TECHNICIAN","PHYSICIST_AND_CHEMIST","PHYSIOTHERAPIST","PLANER_AND_MACHINE_TOOL_SETTER","PLASTERER","PLUMBER_AND_PIPE_FITTER","POLICE_INSPECTOR_AND_DETECTIVE","POLICE_OFFICER","POLICY_ADMINISTRATION_PROFESSIONAL","POLICY_AND_PLANNING_MANAGER","POSTAL_MAIL_CARRIER","POWER_PRODUCTION_PLANT_OPERATOR","PRECIOUS_METALS_WORKER","PRECISION_INSTRUMENT_MAKER_AND_REPAIRER","PRECISION_WORKERS_IN_METAL_AND_RELATED_MATERIAL","PRE_PRIMARY_SCHOOL_TEACHER","PRINTING_AND_RELATED_TRADES_WORKER","PRISON_GUARD","PROCESS_CONTROL_TECHNICIAN","PRODUCTION_CLERK","PRODUCTION_MANAGER","PRODUCT_AND_GARMENT_DESIGNER","PRODUCT_GRADER_AND_TESTER","PRODUCT_LABELLER","PROFESSIONAL_SERVICES_MANAGER","PROGRAMMER","PROGRAM_ANALYST","PROPERTY_MANAGER","PROTECTIVE_SERVICES_WORKER","PSYCHOLOGIST","PUBLIC_RELATIONS_PROFESSIONAL","PULP_AND_PAPERMAKING_PLANT_OPERATOR","QUALITY_INSPECTOR","RADIO_AND_TELEVISION_ANNOUNCER","RAILWAY_BRAKE_SIGNAL_AND_SWITCH_OPERATOR","RAIL_AND_MOTOR_VEHICLE_DRIVER","REAL_ESTATE_AGENT_AND_PROPERTY_MANAGER","RECEPTIONIST","RECYCLE_WORKER","REFUSE_WORKER_AND_OTHER_ELEMENTARY_WORKER","RELIGIOUS_ASSOCIATE_PROFESSIONAL","RELIGIOUS_PROFESSIONAL","RESEARCH_AND_DEVELOPMENT_MANAGER","RESTAURANT_MANAGER","RETAIL_AND_WHOLESALE_BUYER","RETAIL_AND_WHOLESALE_TRADE_MANAGER","RIGGER_AND_CABLE_SPLICER","ROOFER","RUBBER_AND_PLASTIC_PRODUCTS_MACHINE_OPERATOR","SALES_AND_MARKETING_MANAGER","SALES_AND_PURCHASING_AGENT_AND_BROKER","SALES_DEMONSTRATOR","SALES_MARKETING_AND_PUBLIC_RELATIONS_PROFESSIONAL","SALES_PROFESSIONAL","SALES_WORKER","SAWMILL_SAWYER_AND_WOOD_TREATER","SCIENCE_AND_ENGINEERING_ASSOCIATE_PROFESSIONAL","SCIENCE_ENGINEERING_AND_ICT_SALES_PROFESSIONAL","SCIENCE_PROFESSIONAL","SECRETARY","SECURITIES_AND_FINANCE_DEALER_AND_BROKER","SECURITY_GUARD","SENIOR_GOVERNMENT_OFFICIAL","SERVICE_AND_SALES_WORKER","SEWING_EMBROIDERY_AND_RELATED_WORKER","SHEET_METAL_WORKER","SHELF_FILLER","SHIP_AND_AIRCRAFT_CONTROLLER_AND_TECHNICIAN","SHIP_DECK_CREW_AND_RELATED_WORKER","SHIP_DECK_OFFICER_AND_PILOT","SHIP_ENGINEER","SHOE_MAKER_AND_RELATED_WORKER","SHOP_SALESPERSON","SHOP_SALES_ASSISTANT","SKILLED_AGRICULTURAL_FORESTRY_AND_FISHERY_WORKER","SOCIAL_AND_RELIGIOUS_PROFESSIONAL","SOCIAL_WORKER","SOCIAL_WORK_AND_COUNSELLING_PROFESSIONAL","SOCIOLOGISTS_ANTHROPOLOGIST_AND_RELATED_PROFESSIONAL","SOFTWARE_AND_APPLICATIONS_DEVELOPER_AND_ANALYST","SOFTWARE_DEVELOPER","SPECIAL_EDUCATION_TEACHER","SPEECH_THERAPIST","SPORTS_AND_FITNESS_WORKER","SPORTS_COACHES_INSTRUCTOR_AND_OFFICIAL","STATIONARY_PLANT_AND_MACHINE_OPERATOR","STEEL_STRUCTURAL_AND_RELATED_TRADES_WORKER","STOCKMAN","STOCK_CLERK","STONEMASONS_STONE_CUTTERS_SPLITTER_AND_CARVER","STONE_CUTTERS_CARVER_AND_FINISHER","STREET_AND_MARKET_SALESPERSON","STREET_SERVICES_WORKER","STREET_VENDOR","STRUCTURAL_METAL_PREPARER_AND_ERECTOR","SUBSISTENCE_CROP_FARMER","SUBSISTENCE_FARMERS_FISHERS_HUNTER_AND_GATHERER","SUBSISTENCE_FISHERS_HUNTERS_TRAPPER_AND_GATHERER","SUBSISTENCE_LIVESTOCK_FARMER","SUPPLY_AND_DISTRIBUTION_MANAGER","SUPPLY_DISTRIBUTION_AND_RELATED_MANAGER","SURGEON","SURVEYOR","SWITCHBOARD_OPERATOR","SYSTEMS_ADMINISTRATOR","TAILORS_DRESSMAKERS_FURRIER_AND_HATTER","TANNER_AND_FELLMONGER","TAX_AND_RELATED_GOVERNMENT_ASSOCIATE_PROFESSIONAL","TECHNICAL_AND_MEDICAL_SALES_PROFESSIONAL","TELECOMMUNICATION_AND_BROADCASTING_TECHNICIAN","TELECOMMUNICATIONS_ENGINEER","TELEPHONE_SALESPERSON","TELEPHONE_SWITCHBOARD_OPERATOR","TERTIARY_EDUCATION_TEACHER","TEXTILE_LEATHER_AND_RELATED_TRADES_WORKER","TOBACCO_PREPARER_AND_TOBACCO_PRODUCTS_MAKER","TOOL_MAKER_AND_RELATED_WORKER","TOWN_AND_TRAFFIC_PLANNER","TRADE_BROKER","TRADITIONAL_AND_COMPLEMENTARY_MEDICINE_PROFESSIONAL","TRAINING_AND_STAFF_DEVELOPMENT_PROFESSIONAL","TRANSPORT_AND_STORAGE_LABOURER","TRANSPORT_CLERK","TRANSPORT_CONDUCTOR","TRAVEL_ATTENDANT_AND_TRAVEL_STEWARD","TRAVEL_CONSULTANT_AND_CLERK","TRAVEL_GUIDE","TYPIST_AND_WORD_PROCESSING_OPERATOR","UNIVERSITY_AND_HIGHER_EDUCATION_TEACHER","UPHOLSTERER_AND_RELATED_WORKER","VEHICLE_WINDOW_CLEANER","VETERINARIAN","VETERINARY_TECHNICIAN_AND_ASSISTANT","VISUAL_ARTIST","VOCATIONAL_EDUCATION_TEACHER","WAITER","WATCH_AND_CLOCK_MAKER_AND_REPAIRER","WEAVING_AND_KNITTING_MACHINE_OPERATOR","WEB_AND_MULTIMEDIA_DEVELOPER","WEB_DEVELOPER","WEB_TECHNICIAN","WELDER_AND_FLAME_CUTTER","WELL_DRILLER_AND_BORER_AND_RELATED_WORKER","WOOD_PROCESSING_AND_PAPERMAKING_PLANT_OPERATOR","WOOD_TREATER","WOOD_WORKING_MACHINE_TOOL_SETTER_AND_OPERATOR","WRITER_AND_CREATIVE_OR_PERFORMING_ARTIST","YOUTH_AND_COMMUNITY_WORKER"],"type":"string","x-order":5},"latestOccupationDescription":{"description":"Description of latest occupation. Required when latestOccupation is OTHER.","example":"Freelance consultant","type":"string","x-order":6},"primaryAccountPurpose":{"description":"Primary purpose for the account","enum":["CHARITABLE_DONATIONS","ECOMMERCE_RETAIL_PAYMENTS","INVESTMENT_PURPOSES","OPERATING_A_COMPANY","OTHER","PAYMENTS_TO_FROM_FRIENDS_OR_FAMILY_ABROAD","PERSONAL_OR_LIVING_EXPENSES","PROTECT_WEALTH","PURCHASE_GOODS_AND_SERVICES","RECEIVE_PAYMENTS_FOR_FREELANCING","RECEIVE_SALARY"],"example":"PERSONAL_OR_LIVING_EXPENSES","type":"string","x-order":7},"primaryAccountPurposeOther":{"description":"Free-text description of the account purpose. Required when primaryAccountPurpose is OTHER.","example":"Receiving grant disbursements for a research nonprofit","type":"string","x-order":8},"monthlyUsdVolume":{"description":"Expected monthly USD volume","enum":["0-4999","5000-9999","10000-49999","50000+"],"example":"0-4999","type":"string","x-order":9},"isTransactingOnBehalfOfOthers":{"description":"Whether the individual is transacting on behalf of others","example":false,"type":"boolean","x-order":10},"transactionCurrencies":{"description":"Currencies the individual expects to transact in","example":["USD"],"items":{"enum":["ARS","BOB","BRL","CLP","COP","CRC","EUR","MXN","PEN","USD","ZAR"],"type":"string"},"type":"array","x-order":11}},"required":["type","sourceOfFunds","employmentStatus","primaryAccountPurpose","monthlyUsdVolume","isTransactingOnBehalfOfOthers","transactionCurrencies"],"type":"object"},"IndividualFinancialInformation":{"description":"Individual Financial Information","properties":{"currentEmploymentStatus":{"description":"Current employment status of the individual.","enum":["EMPLOYED","HOMEMAKER","RETIRED","SELF_EMPLOYED","STUDENT","UNEMPLOYED"],"example":"EMPLOYED","title":"Current Employment Status","type":"string"},"isTransactingOnBehalfOfOthers":{"description":"Whether the individual is transacting on behalf of others","example":false,"title":"Transacting on Behalf of Others","type":"boolean"},"latestOccupation":{"description":"Latest occupation of the individual","enum":["ACCOMMODATION_AND_FOOD_SERVICE_MANAGER","ACCOUNTANT","ACCOUNTING_ASSOCIATE_PROFESSIONAL","ACCOUNTING_BOOKKEEPING_AND_ESTIMATING_CLERK","ACTOR","ACTUARIES_MATHEMATICIAN_AND_STATISTICIAN","ADMINISTRATIVE_AND_SPECIALIZED_SECRETARY","ADMINISTRATIVE_SERVICES_MANAGER","ADVERTISING_AND_PUBLIC_RELATIONS_MANAGER","AEROSPACE_ENGINEER","AGED_CARE_WORKER","AGRICULTURAL_AND_INDUSTRIAL_MACHINERY_MECHANIC_AND_REPAIRER","AGRICULTURAL_ENGINEER","AGRICULTURAL_FORESTRY_AND_FISHERY_LABOURER","AGRICULTURAL_FORESTRY_AND_FISHERY_PRODUCTS_OPERATOR","AGRICULTURAL_OR_INDUSTRIAL_MACHINERY_ASSEMBLER","AIRCRAFT_ENGINE_MECHANIC_AND_REPAIRER","AIRCRAFT_PILOT_AND_RELATED_ASSOCIATE_PROFESSIONAL","AIR_TRAFFIC_CONTROLLER","AIR_TRAFFIC_SAFETY_ELECTRONICS_TECHNICIAN","AQUACULTURE_WORKER","ARCHITECT","ARCHIVIST_AND_CURATOR","ARMED_FORCES_OCCUPATION","ART_DIRECTOR_AND_MEDIA_PRODUCER","ASSEMBLER","ASTRONOMERS_METEOROLOGIST_AND_GEOPHYSICIST","ATHLETE_AND_SPORTS_PLAYER","ATTENDANTS_PERSONAL_SERVICES_WORKER_AND_TRAVEL_GUIDE","AUTHOR_AND_RELATED_WRITER","AUTOMOTIVE_AND_SURFACE_CLEANING_WORKER","AVIATION_SERVICE_WORKER","BAKERS_PASTRY_COOK_AND_CONFECTIONERY_MAKER","BANK_TELLER_AND_RELATED_CLERK","BEVERAGE_PROCESSING_AND_RELATED_WORKER","BIOLOGICAL_SCIENTIST","BIOMEDICAL_ENGINEER","BLACKSMITHS_HAMMERSMITH_AND_FORGING_PRESS_WORKER","BOOKMAKERS_CROUPIER_AND_RELATED_GAMING_WORKER","BRANCH_MANAGER","BRICKLAYER_AND_RELATED_WORKER","BROADCASTING_AND_AUDIO_VISUAL_TECHNICIAN","BUILDING_AND_HOUSEKEEPING_SUPERVISOR","BUILDING_AND_RELATED_ELECTRICIAN","BUILDING_CARETAKER","BUILDING_FRAME_AND_RELATED_TRADES_WORKER","BUILDING_INSULATION_WORKER","BUILDING_STRUCTURE_CLEANER","BUSINESS_PROFESSIONAL","BUSINESS_SERVICES_AGENT","BUS_AND_TRAM_DRIVER","BUTCHERS_FISHMONGER_AND_RELATED_FOOD_PREPARER","CARPENTER_AND_JOINER","CARPET_FLOOR_AND_WALL_TILER","CAR_VAN_AND_MOTORCYCLE_DRIVER","CASHIER_AND_TICKET_CLERK","CHEMICAL_AND_PHYSICAL_SCIENCE_TECHNICIAN","CHEMICAL_ENGINEER","CHEMICAL_PROCESSING_PLANT_CONTROLLER","CHEMIST","CHIEF_EXECUTIVE_AND_MANAGING_DIRECTOR","CHILD_CARE_WORKER_AND_TEACHERS_AIDE","CHIMNEY_SWEEP_AND_RELATED_WORKER","CIVIL_ENGINEERING_TECHNICIAN","CIVIL_ENGINEER","CLEANER_AND_HELPER","CLINICAL_AND_DIAGNOSTIC_LABORATORY_TECHNICIAN","COOK","CREDIT_AND_LOANS_OFFICER","CROP_FARMER","DAIRY_AND_MILK_PRODUCTS_MACHINE_OPERATOR","DANCER_AND_CHOREOGRAPHER","DATABASE_AND_NETWORK_PROFESSIONAL","DATA_ENTRY_CLERK","DEBT_COLLECTOR_AND_RELATED_WORKER","DECORATOR_AND_COMMERCIAL_DESIGNER","DENTIST","DESIGNER","DIETITIAN_AND_NUTRITIONIST","DIRECTOR_AND_PRODUCER","DOMESTIC_CLEANER_AND_HELPER","DOORKEEPER_AND_RELATED_WORKER","DRAFTER","DRIVING_INSTRUCTOR","ECONOMICS_PROFESSOR","ECONOMIST","EDUCATION_MANAGER","EDUCATION_METHODS_SPECIALIST","ELECTROMECHANICAL_EQUIPMENT_ASSEMBLER","ELECTRONICS_ENGINEER","ELECTRONIC_ENGINEERING_TECHNICIAN","ELECTRONIC_EQUIPMENT_INSTALLER_AND_REPAIRER","ELEMENTARY_SCHOOL_TEACHER","EMBEDDED_SYSTEMS_ENGINEER","EMPLOYMENT_SERVICES_MANAGER","ENGINEERING_PROFESSIONAL","ENVIRONMENTAL_AND_OCCUPATIONAL_HEALTH_INSPECTOR","ENVIRONMENTAL_ENGINEER","ENVIRONMENTAL_PROTECTION_PROFESSIONAL","EVENT_PLANNER","EXCAVATING_AND_EARTHMOVING_EQUIPMENT_OPERATOR","FARM_EQUIPMENT_MECHANIC","FASHION_AND_OTHER_MODEL","FIBRE_PREPARING_SPINNING_AND_WINDING_MACHINE_OPERATOR","FILM_STAGE_AND_RELATED_DIRECTOR_AND_PRODUCER","FINANCE_MANAGER","FINANCIAL_ANALYST","FINANCIAL_AND_INSURANCE_SERVICES_BRANCH_MANAGER","FINANCIAL_SERVICES_MANAGER","FIRE_FIGHTER","FISHERY_WORKERS_HUNTER_AND_TRAPPER","FITNESS_AND_RECREATION_INSTRUCTOR_AND_PROGRAM_LEADER","FLIGHT_ATTENDANT_AND_TRAVEL_STEWARD","FLOOR_LAYER_AND_TILE_SETTER","FLORIST","FOOD_AND_RELATED_PRODUCTS_MACHINE_OPERATOR","FOOD_PREPARATION_ASSISTANT","FOOD_PROCESSING_AND_RELATED_TRADES_WORKER","FOOD_SERVICE_MANAGER","FORESTRY_AND_RELATED_WORKER","FORESTRY_TECHNICIAN","FREIGHT_HANDLER","FUNERAL_DIRECTOR_AND_EMBALMER","FURNITURE_FINISHER_AND_RELATED_WORKER","FUR_AND_LEATHER_PREPARING_MACHINE_OPERATOR","GARMENT_AND_RELATED_TRADES_WORKER","GAS_AND_WATER_OPERATIONS_ENGINEER","GENERAL_OFFICE_CLERK","GEOLOGIST_AND_GEOPHYSICIST","GLASS_MAKERS_CUTTERS_GRINDER_AND_FINISHER","GLAZIER","GRAIN_MILLER_AND_RELATED_WORKER","GRAPHIC_AND_MULTIMEDIA_DESIGNER","HAIRDRESSER","HANDICRAFT_WORKER","HAND_LAUNDERER_AND_PRESSER","HAND_PACKER","HEALTH_ASSOCIATE_PROFESSIONAL","HEALTH_CARE_ASSISTANT","HEALTH_PROFESSIONAL","HEALTH_SERVICES_MANAGER","HEAVY_TRUCK_AND_LORRY_DRIVER","HIGH_SCHOOL_TEACHER","HOME_BASED_PERSONAL_CARE_WORKER","HOSPITALITY_RETAIL_AND_OTHER_SERVICES_MANAGER","HOSPITAL_ORDERLY","HOTEL_AND_RESTAURANT_MANAGER","HOTEL_RECEPTIONIST","HOUSEKEEPER_AND_RELATED_WORKER","HUMAN_RESOURCES_SPECIALIST","HUMAN_RESOURCE_MANAGER","ICT_OPERATION_AND_USER_SUPPORT_TECHNICIAN","ICT_OPERATIONS_TECHNICIAN","ICT_SERVICE_MANAGER","ICT_USER_SUPPORT_TECHNICIAN","ILLUSTRATOR_AND_GRAPHIC_DESIGNER","IMAGE_AND_SOUND_RECORDING_EQUIPMENT_OPERATOR","INCINERATOR_AND_WATER_TREATMENT_PLANT_OPERATOR","INDUSTRIAL_AND_PRODUCTION_ENGINEER","INFORMATION_AND_COMMUNICATIONS_TECHNOLOGY_SERVICE_MANAGER","INFORMATION_CLERK","INFORMATION_SERVICES_MANAGER","INSURANCE_REPRESENTATIVE","INTERIOR_DESIGNER_AND_DECORATOR","JEWELLERY_AND_PRECIOUS_METAL_WORKER","JUDGE","KEYBOARD_OPERATOR","KITCHEN_HELPER","LAUNDRY_MACHINE_OPERATOR","LAWYER","LEGAL_PROFESSIONAL","LEGAL_SECRETARY","LEGISLATOR_AND_SENIOR_OFFICIAL","LIBRARIAN_AND_RELATED_INFORMATION_PROFESSIONAL","LIBRARY_CLERK","LIFE_SCIENCE_TECHNICIAN","LIVESTOCK_AND_DAIRY_PRODUCER","LIVESTOCK_FARMER","LODGING_HOUSEKEEPING_AND_RESTAURANT_SERVICES_WORKER","LOGGING_AND_FORESTRY_LABOURER","LOGISTICIAN_AND_RELATED_PROFESSIONAL","MACHINE_TOOL_OPERATOR","MAIL_CARRIER_AND_SORTING_CLERK","MANAGEMENT_AND_ORGANIZATION_ANALYST","MANAGING_DIRECTOR_AND_CHIEF_EXECUTIVE","MANUFACTURING_LABOURER","MANUFACTURING_MANAGER","MARKETING_AND_SALES_MANAGER","MARKETING_PROFESSIONAL","MARKET_GARDENER_AND_CROP_GROWER","MARKET_ORIENTED_ANIMAL_PRODUCER","MARKET_ORIENTED_SKILLED_AGRICULTURAL_WORKER","MATHEMATICIANS_ACTUARY_AND_STATISTICIAN","MEAT_FISH_AND_RELATED_FOOD_PREPARER","MECHANICAL_ENGINEERING_TECHNICIAN","MECHANICAL_ENGINEER","MECHANICAL_MACHINERY_ASSEMBLER","MEDICAL_AND_DENTAL_PROSTHETIC_TECHNICIAN","MEDICAL_AND_PHARMACEUTICAL_SALES_REPRESENTATIVE","MEDICAL_DIAGNOSTIC_AND_TREATMENT_TECHNICIAN","MEDICAL_DOCTOR","MEDICAL_EQUIPMENT_TECHNICIAN","MEDICAL_IMAGING_AND_THERAPEUTIC_EQUIPMENT_TECHNICIAN","MEDICAL_LABORATORY_TECHNICIAN","MEDICAL_RECORD_AND_HEALTH_INFORMATION_TECHNICIAN","METAL_FINISHING_PLATING_AND_COATING_MACHINE_OPERATOR","METAL_PROCESSING_PLANT_OPERATOR","METAL_WORKING_MACHINE_TOOL_SETTER_AND_OPERATOR","METEOROLOGIST","MIDWIFERY_AND_NURSING_PROFESSIONAL","MIDWIFERY_ASSOCIATE_PROFESSIONAL","MIDWIFE","MINERAL_AND_STONE_PROCESSING_PLANT_OPERATOR","MINING_AND_CONSTRUCTION_LABOURER","MINING_AND_METALLURGICAL_PROCESS_CONTROLLER","MINING_CONSTRUCTION_AND_MANUFACTURING_SUPERVISOR","MINING_ENGINEERS_METALLURGIST_AND_RELATED_PROFESSIONAL","MIXED_CROP_AND_LIVESTOCK_FARMER","MOBILE_PLANT_OPERATOR","MOTOR_VEHICLE_MECHANIC_AND_REPAIRER","MOTOR_VEHICLE_WINDOW_CLEANER_AND_RELATED_WORKER","MUSICIANS_SINGER_AND_COMPOSER","NUMERICAL_CLERK","NURSING_AND_MIDWIFERY_ASSOCIATE_PROFESSIONAL","NURSING_PROFESSIONAL","OCCUPATIONAL_HEALTH_AND_SAFETY_PROFESSIONAL","OFFICE_CLERK","OFFICE_MANAGER","OFFICE_SUPERVISOR","OPTICAL_AND_ELECTRONIC_EQUIPMENT_OPERATOR","OTHER","OTHER_AGRICULTURAL_FORESTRY_AND_FISHERY_WORKER","OTHER_ASSEMBLER","OTHER_BUSINESS_SERVICES_AGENT","OTHER_CLEANER","OTHER_CRAFT_AND_RELATED_WORKER","OTHER_EDUCATION_PROFESSIONAL","OTHER_ELEMENTARY_WORKER","OTHER_HANDICRAFT_WORKER","OTHER_HEALTH_PROFESSIONAL","OTHER_HEAVY_VEHICLE_AND_MOBILE_EQUIPMENT_MECHANIC_AND_REPAIRER","OTHER_INFORMATION_SERVICES_MANAGER","OTHER_LABOURER","OTHER_MACHINE_OPERATOR_AND_ASSEMBLER","OTHER_MANUFACTURING_MANAGER","OTHER_MINING_CONSTRUCTION_MANUFACTURING_AND_TRANSPORT_SUPERVISOR","OTHER_MOBILE_PLANT_OPERATOR","OTHER_PLANT_AND_MACHINE_OPERATOR","OTHER_PROCESS_CONTROL_TECHNICIAN","OTHER_PRODUCTION_AND_SPECIALIZED_SERVICES_MANAGER","OTHER_PRODUCTION_MANAGER","OTHER_PROFESSIONAL","OTHER_SALES_SUPPORT_WORKER","OTHER_SALES_WORKER","OTHER_SERVICES_MANAGER","OTHER_SHIP_AND_AIRCRAFT_CONTROLLER_AND_TECHNICIAN","OTHER_STATIONARY_PLANT_AND_MACHINE_OPERATOR","OTHER_TEACHING_PROFESSIONAL","OTHER_TECHNICIAN_AND_ASSOCIATE_PROFESSIONAL","OTHER_TRADER","OTHER_WORKER","PAINTERS_BUILDING_STRUCTURE_CLEANER_AND_RELATED_TRADES_WORKER","PARAMEDICAL_PRACTITIONER","PAYROLL_CLERK","PERSONAL_CARE_WORKER","PERSONAL_CARE_WORKERS_IN_HEALTH_SERVICE","PERSONAL_SERVICES_WORKER","PERSONNEL_CLERK","PEST_CONTROLLER_AND_FUMIGATOR","PETROLEUM_AND_NATURAL_GAS_REFINING_PLANT_OPERATOR","PHARMACEUTICAL_TECHNICIAN_AND_ASSISTANT","PHARMACIST","PHILOSOPHY_AND_RELIGION_PROFESSIONAL","PHOTOGRAPHER","PHYSICAL_AND_EARTH_SCIENCE_TECHNICIAN","PHYSICAL_AND_ENGINEERING_SCIENCE_TECHNICIAN","PHYSICIST_AND_CHEMIST","PHYSIOTHERAPIST","PLANER_AND_MACHINE_TOOL_SETTER","PLASTERER","PLUMBER_AND_PIPE_FITTER","POLICE_INSPECTOR_AND_DETECTIVE","POLICE_OFFICER","POLICY_ADMINISTRATION_PROFESSIONAL","POLICY_AND_PLANNING_MANAGER","POSTAL_MAIL_CARRIER","POWER_PRODUCTION_PLANT_OPERATOR","PRECIOUS_METALS_WORKER","PRECISION_INSTRUMENT_MAKER_AND_REPAIRER","PRECISION_WORKERS_IN_METAL_AND_RELATED_MATERIAL","PRE_PRIMARY_SCHOOL_TEACHER","PRINTING_AND_RELATED_TRADES_WORKER","PRISON_GUARD","PROCESS_CONTROL_TECHNICIAN","PRODUCTION_CLERK","PRODUCTION_MANAGER","PRODUCT_AND_GARMENT_DESIGNER","PRODUCT_GRADER_AND_TESTER","PRODUCT_LABELLER","PROFESSIONAL_SERVICES_MANAGER","PROGRAMMER","PROGRAM_ANALYST","PROPERTY_MANAGER","PROTECTIVE_SERVICES_WORKER","PSYCHOLOGIST","PUBLIC_RELATIONS_PROFESSIONAL","PULP_AND_PAPERMAKING_PLANT_OPERATOR","QUALITY_INSPECTOR","RADIO_AND_TELEVISION_ANNOUNCER","RAILWAY_BRAKE_SIGNAL_AND_SWITCH_OPERATOR","RAIL_AND_MOTOR_VEHICLE_DRIVER","REAL_ESTATE_AGENT_AND_PROPERTY_MANAGER","RECEPTIONIST","RECYCLE_WORKER","REFUSE_WORKER_AND_OTHER_ELEMENTARY_WORKER","RELIGIOUS_ASSOCIATE_PROFESSIONAL","RELIGIOUS_PROFESSIONAL","RESEARCH_AND_DEVELOPMENT_MANAGER","RESTAURANT_MANAGER","RETAIL_AND_WHOLESALE_BUYER","RETAIL_AND_WHOLESALE_TRADE_MANAGER","RIGGER_AND_CABLE_SPLICER","ROOFER","RUBBER_AND_PLASTIC_PRODUCTS_MACHINE_OPERATOR","SALES_AND_MARKETING_MANAGER","SALES_AND_PURCHASING_AGENT_AND_BROKER","SALES_DEMONSTRATOR","SALES_MARKETING_AND_PUBLIC_RELATIONS_PROFESSIONAL","SALES_PROFESSIONAL","SALES_WORKER","SAWMILL_SAWYER_AND_WOOD_TREATER","SCIENCE_AND_ENGINEERING_ASSOCIATE_PROFESSIONAL","SCIENCE_ENGINEERING_AND_ICT_SALES_PROFESSIONAL","SCIENCE_PROFESSIONAL","SECRETARY","SECURITIES_AND_FINANCE_DEALER_AND_BROKER","SECURITY_GUARD","SENIOR_GOVERNMENT_OFFICIAL","SERVICE_AND_SALES_WORKER","SEWING_EMBROIDERY_AND_RELATED_WORKER","SHEET_METAL_WORKER","SHELF_FILLER","SHIP_AND_AIRCRAFT_CONTROLLER_AND_TECHNICIAN","SHIP_DECK_CREW_AND_RELATED_WORKER","SHIP_DECK_OFFICER_AND_PILOT","SHIP_ENGINEER","SHOE_MAKER_AND_RELATED_WORKER","SHOP_SALESPERSON","SHOP_SALES_ASSISTANT","SKILLED_AGRICULTURAL_FORESTRY_AND_FISHERY_WORKER","SOCIAL_AND_RELIGIOUS_PROFESSIONAL","SOCIAL_WORKER","SOCIAL_WORK_AND_COUNSELLING_PROFESSIONAL","SOCIOLOGISTS_ANTHROPOLOGIST_AND_RELATED_PROFESSIONAL","SOFTWARE_AND_APPLICATIONS_DEVELOPER_AND_ANALYST","SOFTWARE_DEVELOPER","SPECIAL_EDUCATION_TEACHER","SPEECH_THERAPIST","SPORTS_AND_FITNESS_WORKER","SPORTS_COACHES_INSTRUCTOR_AND_OFFICIAL","STATIONARY_PLANT_AND_MACHINE_OPERATOR","STEEL_STRUCTURAL_AND_RELATED_TRADES_WORKER","STOCKMAN","STOCK_CLERK","STONEMASONS_STONE_CUTTERS_SPLITTER_AND_CARVER","STONE_CUTTERS_CARVER_AND_FINISHER","STREET_AND_MARKET_SALESPERSON","STREET_SERVICES_WORKER","STREET_VENDOR","STRUCTURAL_METAL_PREPARER_AND_ERECTOR","SUBSISTENCE_CROP_FARMER","SUBSISTENCE_FARMERS_FISHERS_HUNTER_AND_GATHERER","SUBSISTENCE_FISHERS_HUNTERS_TRAPPER_AND_GATHERER","SUBSISTENCE_LIVESTOCK_FARMER","SUPPLY_AND_DISTRIBUTION_MANAGER","SUPPLY_DISTRIBUTION_AND_RELATED_MANAGER","SURGEON","SURVEYOR","SWITCHBOARD_OPERATOR","SYSTEMS_ADMINISTRATOR","TAILORS_DRESSMAKERS_FURRIER_AND_HATTER","TANNER_AND_FELLMONGER","TAX_AND_RELATED_GOVERNMENT_ASSOCIATE_PROFESSIONAL","TECHNICAL_AND_MEDICAL_SALES_PROFESSIONAL","TELECOMMUNICATION_AND_BROADCASTING_TECHNICIAN","TELECOMMUNICATIONS_ENGINEER","TELEPHONE_SALESPERSON","TELEPHONE_SWITCHBOARD_OPERATOR","TERTIARY_EDUCATION_TEACHER","TEXTILE_LEATHER_AND_RELATED_TRADES_WORKER","TOBACCO_PREPARER_AND_TOBACCO_PRODUCTS_MAKER","TOOL_MAKER_AND_RELATED_WORKER","TOWN_AND_TRAFFIC_PLANNER","TRADE_BROKER","TRADITIONAL_AND_COMPLEMENTARY_MEDICINE_PROFESSIONAL","TRAINING_AND_STAFF_DEVELOPMENT_PROFESSIONAL","TRANSPORT_AND_STORAGE_LABOURER","TRANSPORT_CLERK","TRANSPORT_CONDUCTOR","TRAVEL_ATTENDANT_AND_TRAVEL_STEWARD","TRAVEL_CONSULTANT_AND_CLERK","TRAVEL_GUIDE","TYPIST_AND_WORD_PROCESSING_OPERATOR","UNIVERSITY_AND_HIGHER_EDUCATION_TEACHER","UPHOLSTERER_AND_RELATED_WORKER","VEHICLE_WINDOW_CLEANER","VETERINARIAN","VETERINARY_TECHNICIAN_AND_ASSISTANT","VISUAL_ARTIST","VOCATIONAL_EDUCATION_TEACHER","WAITER","WATCH_AND_CLOCK_MAKER_AND_REPAIRER","WEAVING_AND_KNITTING_MACHINE_OPERATOR","WEB_AND_MULTIMEDIA_DEVELOPER","WEB_DEVELOPER","WEB_TECHNICIAN","WELDER_AND_FLAME_CUTTER","WELL_DRILLER_AND_BORER_AND_RELATED_WORKER","WOOD_PROCESSING_AND_PAPERMAKING_PLANT_OPERATOR","WOOD_TREATER","WOOD_WORKING_MACHINE_TOOL_SETTER_AND_OPERATOR","WRITER_AND_CREATIVE_OR_PERFORMING_ARTIST","YOUTH_AND_COMMUNITY_WORKER"],"example":"SOFTWARE_DEVELOPER","title":"Latest Occupation","type":"string"},"latestOccupationDescription":{"description":"Description of occupation when latestOccupation starts with OTHER","example":"Freelance consultant","title":"Latest Occupation Description","type":"string"},"monthlyUsdVolume":{"description":"Expected volume of transactions in USD per month","example":50000,"maximum":100000000000,"minimum":0,"title":"Monthly USD Volume","type":"number"},"primaryAccountPurpose":{"description":"Primary purpose for using the account","enum":["CHARITABLE_DONATIONS","ECOMMERCE_RETAIL_PAYMENTS","INVESTMENT_PURPOSES","OPERATING_A_COMPANY","OTHER","PAYMENTS_TO_FROM_FRIENDS_OR_FAMILY_ABROAD","PERSONAL_OR_LIVING_EXPENSES","PROTECT_WEALTH","PURCHASE_GOODS_AND_SERVICES","RECEIVE_PAYMENTS_FOR_FREELANCING","RECEIVE_SALARY"],"example":"PERSONAL_OR_LIVING_EXPENSES","title":"Primary Account Purpose","type":"string"},"sourceOfFunds":{"description":"Individual's primary source of funds","enum":["COMPANY_FUNDS","ECOMMERCE_RESELLER","GAMBLING_PROCEEDS","GIFTS","GOVERNMENT_BENEFITS_TAX_REFUNDS","INHERITANCE","INVESTMENTS_LOANS","PENSION_RETIREMENT","SALARY","SALE_OF_ASSETS_REAL_ESTATE","SAVINGS","SOMEONE_ELSES_FUNDS"],"example":"SALARY","title":"Source of Funds","type":"string"},"sourceOfFundsDocument":{"allOf":[{"$ref":"#/components/schemas/SourceOfFundsDocumentUpload"}],"description":"Supporting document for the individual's primary source of funds. Required when monthly USD volume is $5,000 or more.","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"EMPLOYMENT_INCOME","filename":"pay_stub.pdf"},"title":"Source of Funds Document"},"transactionCurrencies":{"description":"List of currencies the individual intends to use for payments or withdrawals","example":["USD","EUR"],"items":{"enum":["ARS","BOB","BRL","CLP","COP","CRC","EUR","MXN","PEN","USD","ZAR"],"type":"string"},"title":"Transaction Currencies","type":"array"}},"required":["sourceOfFunds","currentEmploymentStatus","primaryAccountPurpose","latestOccupation","monthlyUsdVolume","isTransactingOnBehalfOfOthers","transactionCurrencies"],"type":"object"},"IndividualIdentityDocumentAttestation":{"properties":{"type":{"enum":["individualIdentityDocument"],"type":"string","x-order":1},"governmentId":{"description":"Government ID document.","discriminator":{"mapping":{"citizenshipCertificate":"#/components/schemas/CitizenshipCertificateIdentityDocument","cnh":"#/components/schemas/CnhIdentityDocument","consularId":"#/components/schemas/ConsularIdIdentityDocument","driverLicense":"#/components/schemas/DriverLicenseIdentityDocument","foreignId":"#/components/schemas/ForeignIdIdentityDocument","healthInsuranceCard":"#/components/schemas/HealthInsuranceCardIdentityDocument","internalPassport":"#/components/schemas/InternalPassportIdentityDocument","keypassId":"#/components/schemas/KeypassIdIdentityDocument","longTermPass":"#/components/schemas/LongTermPassIdentityDocument","municipalId":"#/components/schemas/MunicipalIdIdentityDocument","myNumberCard":"#/components/schemas/MyNumberCardIdentityDocument","nationalId":"#/components/schemas/NationalIdIdentityDocument","nbiClearance":"#/components/schemas/NbiClearanceIdentityDocument","ofwId":"#/components/schemas/OfwIdIdentityDocument","panCard":"#/components/schemas/PanCardIdentityDocument","passport":"#/components/schemas/PassportIdentityDocument","passportCard":"#/components/schemas/PassportCardIdentityDocument","permanentResidenceCard":"#/components/schemas/PermanentResidenceCardIdentityDocument","postalId":"#/components/schemas/PostalIdIdentityDocument","residencePermit":"#/components/schemas/ResidencePermitIdentityDocument","sssId":"#/components/schemas/SssIdIdentityDocument","stateId":"#/components/schemas/StateIdIdentityDocument","travelDocument":"#/components/schemas/TravelDocumentIdentityDocument","tribalId":"#/components/schemas/TribalIdIdentityDocument","umid":"#/components/schemas/UmidIdentityDocument","visa":"#/components/schemas/VisaIdentityDocument","voterId":"#/components/schemas/VoterIdIdentityDocument","workPermit":"#/components/schemas/WorkPermitIdentityDocument"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PassportIdentityDocument","title":"Passport"},{"$ref":"#/components/schemas/DriverLicenseIdentityDocument","title":"Driver's License"},{"$ref":"#/components/schemas/CnhIdentityDocument","title":"CNH (Brazilian Driver's License)"},{"$ref":"#/components/schemas/NationalIdIdentityDocument","title":"National ID"},{"$ref":"#/components/schemas/StateIdIdentityDocument","title":"State ID"},{"$ref":"#/components/schemas/PassportCardIdentityDocument","title":"Passport Card"},{"$ref":"#/components/schemas/PermanentResidenceCardIdentityDocument","title":"Permanent Residence Card"},{"$ref":"#/components/schemas/VisaIdentityDocument","title":"Visa"},{"$ref":"#/components/schemas/ResidencePermitIdentityDocument","title":"Residence Permit"},{"$ref":"#/components/schemas/CitizenshipCertificateIdentityDocument","title":"Citizenship Certificate"},{"$ref":"#/components/schemas/ConsularIdIdentityDocument","title":"Consular ID"},{"$ref":"#/components/schemas/ForeignIdIdentityDocument","title":"Foreign ID"},{"$ref":"#/components/schemas/HealthInsuranceCardIdentityDocument","title":"Health Insurance Card"},{"$ref":"#/components/schemas/InternalPassportIdentityDocument","title":"Internal Passport"},{"$ref":"#/components/schemas/KeypassIdIdentityDocument","title":"Keypass ID"},{"$ref":"#/components/schemas/LongTermPassIdentityDocument","title":"Long Term Pass"},{"$ref":"#/components/schemas/MunicipalIdIdentityDocument","title":"Municipal ID"},{"$ref":"#/components/schemas/MyNumberCardIdentityDocument","title":"My Number Card"},{"$ref":"#/components/schemas/NbiClearanceIdentityDocument","title":"NBI Clearance"},{"$ref":"#/components/schemas/OfwIdIdentityDocument","title":"OFW ID"},{"$ref":"#/components/schemas/PanCardIdentityDocument","title":"PAN Card"},{"$ref":"#/components/schemas/PostalIdIdentityDocument","title":"Postal ID"},{"$ref":"#/components/schemas/SssIdIdentityDocument","title":"SSS ID"},{"$ref":"#/components/schemas/TravelDocumentIdentityDocument","title":"Travel Document"},{"$ref":"#/components/schemas/TribalIdIdentityDocument","title":"Tribal ID"},{"$ref":"#/components/schemas/UmidIdentityDocument","title":"UMID"},{"$ref":"#/components/schemas/VoterIdIdentityDocument","title":"Voter ID"},{"$ref":"#/components/schemas/WorkPermitIdentityDocument","title":"Work Permit"}],"x-order":2}},"required":["type","governmentId"],"type":"object"},"IndividualIdentityInfo":{"description":"Individual Identity Info","properties":{"governmentIdCountryCode":{"description":"Country Code of Government ID Issuer","example":"US","title":"Government ID Country Code","type":"string"},"governmentIdDocument":{"allOf":[{"$ref":"#/components/schemas/DocumentUpload"}],"description":"Front of government ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"GOVERNMENT_ID","filename":"drivers_license_front.pdf"},"title":"Front of Government ID"},"governmentIdDocumentBack":{"allOf":[{"$ref":"#/components/schemas/DocumentUpload"}],"description":"Back of government ID document with filename and base64 content. REQUIRED for Individual organization verification with non-passport ID types (Driver License, State ID, National ID, etc.). NOT ALLOWED for UBOs and Control Persons in Business organization verification - requests will be rejected with BadRequestException. Passports are single-sided and do not require a back document.","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"GOVERNMENT_ID_BACK","filename":"drivers_license_back.pdf"},"title":"Back of Government ID"},"governmentIdNumber":{"description":"Government ID Number","example":"1234567890","title":"Government ID Number: Example, Drivers License Number","type":"string"},"governmentIdType":{"description":"Type of Government ID","enum":["PASSPORT","PASSPORT_CARD","DRIVER_LICENSE","STATE_ID","PERMANENT_RESIDENCE_CARD","VISA","NATIONAL_ID","RESIDENCE_PERMIT","VOTER_ID","CITIZENSHIP_CERTIFICATE","HEALTH_INSURANCE_CARD","WORK_PERMIT","CONSULAR_ID","FOREIGN_ID","MY_NUMBER_CARD","PAN_CARD","LONG_TERM_PASS","NBI_CLEARANCE","OFW_ID","POSTAL_ID","SSS_ID","UMID","MUNICIPAL_ID","TRAVEL_DOCUMENT","INTERNAL_PASSPORT","TRIBAL_ID","KEYPASS_ID","CNH"],"example":"DRIVER_LICENSE","title":"Government ID Type","type":"string"}},"required":["governmentIdCountryCode","governmentIdType","governmentIdNumber","governmentIdDocument"],"type":"object"},"IndividualIdentityInfoV2":{"description":"Individual Identity Info for new individual organization type (individualV2)","properties":{"governmentId":{"description":"Government identification with type-specific document requirements.","example":{"countryCode":"US","driverLicenseBackDocument":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"drivers_license_back.pdf"},"driverLicenseFrontDocument":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"drivers_license_front.pdf"},"driverLicenseNumber":"D1234567","type":"driverLicense"},"oneOf":[{"$ref":"#/components/schemas/PassportGovernmentId"},{"$ref":"#/components/schemas/PassportCardGovernmentId"},{"$ref":"#/components/schemas/DriverLicenseGovernmentId"},{"$ref":"#/components/schemas/StateIdGovernmentId"},{"$ref":"#/components/schemas/PermanentResidenceCardGovernmentId"},{"$ref":"#/components/schemas/VisaGovernmentId"},{"$ref":"#/components/schemas/NationalIdGovernmentId"},{"$ref":"#/components/schemas/ResidencePermitGovernmentId"},{"$ref":"#/components/schemas/VoterIdGovernmentId"},{"$ref":"#/components/schemas/CitizenshipCertificateGovernmentId"},{"$ref":"#/components/schemas/HealthInsuranceCardGovernmentId"},{"$ref":"#/components/schemas/WorkPermitGovernmentId"},{"$ref":"#/components/schemas/ConsularIdGovernmentId"},{"$ref":"#/components/schemas/ForeignIdGovernmentId"},{"$ref":"#/components/schemas/MyNumberCardGovernmentId"},{"$ref":"#/components/schemas/PanCardGovernmentId"},{"$ref":"#/components/schemas/LongTermPassGovernmentId"},{"$ref":"#/components/schemas/NbiClearanceGovernmentId"},{"$ref":"#/components/schemas/OfwIdGovernmentId"},{"$ref":"#/components/schemas/PostalIdGovernmentId"},{"$ref":"#/components/schemas/SssIdGovernmentId"},{"$ref":"#/components/schemas/UmidGovernmentId"},{"$ref":"#/components/schemas/MunicipalIdGovernmentId"},{"$ref":"#/components/schemas/TravelDocumentGovernmentId"},{"$ref":"#/components/schemas/InternalPassportGovernmentId"},{"$ref":"#/components/schemas/TribalIdGovernmentId"},{"$ref":"#/components/schemas/KeypassIdGovernmentId"},{"$ref":"#/components/schemas/CnhGovernmentId"}],"title":"Government ID"}},"required":["governmentId"],"type":"object"},"IndividualName":{"description":"Individual Name","properties":{"firstName":{"description":"Individual's First Name","example":"John","title":"First Name","type":"string"},"lastName":{"description":"Individual's Last Name","example":"Doe","title":"Last Name","type":"string"},"middleName":{"description":"Individual's Middle Name","example":"Robert","title":"Middle Name","type":"string"}},"required":["firstName","lastName"],"type":"object"},"IndividualOrgRequest":{"properties":{"email":{"description":"The primary email address of the individual","type":"string"},"firstName":{"description":"The first name of the individual","type":"string"},"lastName":{"description":"The last name of the individual","type":"string"},"tosRelianceInfo":{"allOf":[{"$ref":"#/components/schemas/TOSRelianceInfo"}],"description":"Optional Terms of Service reliance information. TOS reliance must be enabled by the Mural technical team to use this field."},"type":{"enum":["individual"],"type":"string"}},"required":["type","firstName","lastName","email"],"type":"object"},"IndividualOrganization":{"properties":{"complianceInfo":{"allOf":[{"$ref":"#/components/schemas/OrganizationComplianceInfo"}],"description":"Compliance tier information for this organization."},"createdAt":{"format":"date-time","type":"string"},"currencyCapabilities":{"description":"The currencies that the individual organization can use to fund a Mural account or pay out from a Mural account","items":{"$ref":"#/components/schemas/MuralCurrencyCapability"},"type":"array"},"firstName":{"description":"The first name of the individual","type":"string"},"id":{"format":"uuid","type":"string"},"kycStatus":{"description":"The KYC verification status of the individual","oneOf":[{"$ref":"#/components/schemas/VerificationStatusInactive"},{"$ref":"#/components/schemas/VerificationStatusPending"},{"$ref":"#/components/schemas/VerificationStatusApproved"},{"$ref":"#/components/schemas/VerificationStatusError"},{"$ref":"#/components/schemas/VerificationStatusRejected"}]},"lastName":{"description":"The last name of the individual","type":"string"},"tosStatus":{"description":"The terms of service status of the individual","enum":["NOT_ACCEPTED","NEEDS_REVIEW","ACCEPTED"],"type":"string"},"type":{"enum":["individual"],"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["type","id","createdAt","updatedAt","firstName","lastName","tosStatus","kycStatus","currencyCapabilities","complianceInfo"],"type":"object"},"IndividualPersonalInfo":{"description":"Individual Personal Info","properties":{"birthDate":{"description":"Individual's date of birth (YYYY-MM-DD)","example":"1980-01-01","title":"Individual's date of birth","type":"string"},"firstName":{"description":"Individual's First Name","example":"John","title":"Individual's first name","type":"string"},"individualEmail":{"description":"Individual's email address","example":"john.doe@example.com","title":"Individual's email address","type":"string"},"individualPhoneNumber":{"description":"Individual's phone number","example":"+12125551234","title":"Individual's phone number","type":"string"},"individualResidentialAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Individual's residential address","title":"Individual's residential address"},"lastName":{"description":"Individual's Last Name","example":"Doe","title":"Individual's last name","type":"string"},"nationality":{"description":"Individual's nationality (ISO 3166-1 alpha-2 country code)","example":"US","title":"Individual's nationality","type":"string"},"ownershipPercentage":{"description":"For UBOs on a KYB review, the percentage of the parent business owned by this individual (0-100, up to 2 decimal places). Absent for pure control persons and for solo-individual KYC flows.","example":25,"type":"number"},"taxIdNumber":{"allOf":[{"$ref":"#/components/schemas/TaxIdentificationNumber"}],"description":"Individual's tax identification number with type (e.g., SSN, ITIN, NIT)","example":{"taxIdentificationNumber":"123-45-6789","taxIdentificationNumberType":"SSN"},"title":"Individual's tax identification number"},"title":{"description":"The individual's job title or position at the company (e.g. CEO, CTO, CFO)","example":"CEO","maxLength":100,"title":"Title","type":"string"}},"required":["firstName","lastName","birthDate","nationality","taxIdNumber","individualPhoneNumber","individualEmail","individualResidentialAddress"],"type":"object"},"IndividualPersonalInfoAttestation":{"properties":{"type":{"enum":["individualPersonalInfo"],"type":"string","x-order":1},"name":{"allOf":[{"$ref":"#/components/schemas/IndividualName"}],"description":"Individual's name","example":{"firstName":"Jane","lastName":"Doe","middleName":"Marie"},"x-order":2},"birthDate":{"description":"Individual's date of birth (YYYY-MM-DD)","example":"1990-01-15","type":"string","x-order":3},"nationality":{"description":"Individual's nationality (ISO 3166-1 alpha-2 country code)","example":"US","type":"string","x-order":4},"isPoliticallyExposed":{"description":"Whether the individual is a politically exposed person","example":false,"type":"boolean","x-order":5}},"required":["type","name","birthDate","nationality","isPoliticallyExposed"],"type":"object"},"IndividualPersonalInfoLightAttestation":{"properties":{"type":{"enum":["individualPersonalInfoLight"],"type":"string","x-order":1},"name":{"allOf":[{"$ref":"#/components/schemas/IndividualName"}],"description":"Individual's name","example":{"firstName":"Jane","lastName":"Doe","middleName":"Marie"},"title":"Name","x-order":2},"birthDate":{"description":"Individual's date of birth (YYYY-MM-DD)","example":"1990-01-15","title":"Date of Birth","type":"string","x-order":3},"nationality":{"description":"Individual's nationality (ISO 3166-1 alpha-2 country code)","example":"US","title":"Nationality","type":"string","x-order":4},"phoneNumber":{"description":"Individual's phone number, including country code (e.g. +14155551234)","example":"+14155551234","title":"Phone Number","type":"string","x-order":5},"residentialAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Individual's residential address","title":"Residential Address","x-order":6}},"required":["type","name","birthDate","phoneNumber","residentialAddress"],"type":"object"},"IndividualPersonalInfoV2":{"description":"Personal Information for an Individual","properties":{"birthDate":{"description":"Individual's date of birth (YYYY-MM-DD)","example":"1980-01-01","title":"Birth Date","type":"string"},"individualEmail":{"description":"Email","example":"john.doe@example.com","title":"Individual Email Address","type":"string"},"individualPhoneNumber":{"description":"Individual's phone number","example":"+12125551234","title":"Individual Phone Number","type":"string"},"individualResidentialAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Residential Address","title":"Individual Residential Address"},"name":{"allOf":[{"$ref":"#/components/schemas/IndividualName"}],"description":"Individual's name","example":{"firstName":"John","lastName":"Doe","middleName":"Robert"},"title":"Individual Name"},"nationality":{"description":"Individual's nationality (ISO 3166-1 alpha-2 country code)","example":"US","title":"Nationality","type":"string"},"taxIdNumber":{"allOf":[{"$ref":"#/components/schemas/TaxIdentificationNumber"}],"description":"Individual's tax identification number with type (e.g., SSN, ITIN, NIT)","example":{"taxIdentificationNumber":"123-45-6789","taxIdentificationNumberType":"SSN"},"title":"Tax Identification Number"}},"required":["name","birthDate","nationality","taxIdNumber","individualPhoneNumber","individualEmail","individualResidentialAddress"],"type":"object"},"IndividualProofOfAddressAttestation":{"properties":{"type":{"enum":["individualProofOfAddress"],"type":"string","x-order":1},"proofOfAddressDocuments":{"description":"List of proof-of-address documents","items":{"$ref":"#/components/schemas/ProofOfAddressDocumentReference"},"type":"array","x-order":2}},"required":["type","proofOfAddressDocuments"],"type":"object"},"IndividualRecipientInfo":{"properties":{"email":{"description":"Email address for the recipient. Some destination rails (for example Colombian COP payouts) require an email — if missing for those rails, payout-request creation will fail with `additional_recipient_information_required` listing the missing fields.","format":"email","type":"string"},"firstName":{"description":"The first name of the individual","type":"string"},"lastName":{"description":"The last name of the individual","type":"string"},"physicalAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressInput"}],"description":"The physical address of the individual recipient."},"type":{"enum":["individual"],"type":"string"}},"required":["type","firstName","lastName","physicalAddress"],"type":"object"},"IndividualResidentialAddressAttestation":{"properties":{"type":{"enum":["individualResidentialAddress"],"type":"string","x-order":1},"address":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"Individual's residential address","x-order":2}},"required":["type","address"],"type":"object"},"IndividualSelfiePhotoAttestation":{"properties":{"type":{"enum":["individualSelfiePhoto"],"type":"string","x-order":1},"documentId":{"description":"File ID (UUID) of the selfie photo, returned by the compliance document upload endpoint.","format":"uuid","type":"string","x-order":2}},"required":["type","documentId"],"type":"object"},"IndividualSourceOfFundsAttestation":{"properties":{"type":{"enum":["individualSourceOfFunds"],"type":"string","x-order":1},"sourceOfFundsDocuments":{"description":"List of source-of-funds documents","items":{"$ref":"#/components/schemas/SourceOfFundsDocumentReference"},"type":"array","x-order":2}},"required":["type","sourceOfFundsDocuments"],"type":"object"},"IndividualTaxInfoAttestation":{"properties":{"type":{"enum":["individualTaxInfo"],"type":"string","x-order":1},"taxIdentificationNumber":{"description":"Tax identification number (e.g. SSN for US residents, or the applicable national tax ID).","example":"123-45-6789","type":"string","x-order":2},"taxIdentificationNumberType":{"description":"Type of tax identification number. Must be a type applicable to individuals.","enum":["SSN","ITIN","CPF","CURP","CUIL","NINO","INE","RFC","NIF","STEUER_ID","TCKN","TIN","PAN","ADOAZ","AHV","AOM","BSN","BVN","CDI","CNP","CPR","EGN","EMIRATES_ID","EMSO","FIN","FN","FODSELSNR","HETU","HKID","IDNP","IIN","IK","ITR","JMBG","MN","NIN","NRIC","NRN","PERSONNUMMER","PESEL","PIN","PINFL","PPSN","RICN","RNOKPP","RODNE_CISLO","RP","RRN","SI","SIN","SPI","TFN","UCN","UTR","BIR","BIN","BP","CF","CN","CRIB","CUI","CUIT","ID","ID_BROJ","IDNO","IF","INN","IRD","MATRICULE","MST","NIT","NPWP","NRT","NTN","OIB","PIB","RC","RIF","RN","RTN","RUC","RUT","TRN","UNP","USC","VAT","VOEN"],"example":"SSN","type":"string","x-order":3}},"required":["type","taxIdentificationNumber","taxIdentificationNumberType"],"type":"object"},"InitiateChallengeRequest":{"properties":{"approverId":{"description":"Identifier of the Approver who should receive the email challenge","example":"user123","type":"string"},"publicKey":{"description":"The public key to associate with the email authentication. You can get this from the EndUserCustodialSDK.getPublicKey() method.","example":"04a82bfb0edb13d...","type":"string"}},"required":["publicKey","approverId"],"type":"object"},"InitiateChallengeResponse":{"properties":{"authenticatorId":{"description":"The id needed to create an EndUserCustodialSDK session","example":"auth_1234567890abcdef","type":"string"}},"required":["authenticatorId"],"type":"object"},"InlineBlockchainPayoutRecipientDetails":{"description":"Details about an inline blockchain payout recipient. This includes recipient information and wallet details.","properties":{"blockchain":{"description":"The blockchain network for this payout. SOLANA is returned only for USD payouts.","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA","SOLANA"],"type":"string"},"type":{"enum":["blockchain"],"type":"string"},"walletAddress":{"description":"The wallet address receiving the payout. EVM (0x-prefixed hex) or Solana (base58-encoded 32-byte pubkey), matching the blockchain value.","type":"string"}},"required":["type","walletAddress","blockchain"],"type":"object"},"InlineFiatPayoutRecipientDetails":{"description":"Details about an inline fiat payout recipient. This includes recipient information and bank details.","properties":{"details":{"allOf":[{"$ref":"#/components/schemas/GeneralBankAccountDetails"}],"description":"Bank account details for the inline fiat payout"},"type":{"enum":["fiat"],"type":"string"}},"required":["type","details"],"type":"object"},"InlinePayoutRecipientInfo":{"description":"Recipient information for payouts created using inline recipient and payout details","properties":{"details":{"description":"Details about the inline recipient, discriminated by payout type (fiat or blockchain)","oneOf":[{"$ref":"#/components/schemas/InlineFiatPayoutRecipientDetails","title":"Inline Fiat Payout Recipient Details"},{"$ref":"#/components/schemas/InlineBlockchainPayoutRecipientDetails","title":"Inline Blockchain Payout Recipient Details"}]},"name":{"description":"The name of the recipient","type":"string"},"type":{"enum":["inline"],"type":"string"}},"required":["type","name","details"],"type":"object"},"InsufficientBalanceAvailableBalance":{"properties":{"amount":{"description":"Available balance amount","type":"string"},"blockchain":{"description":"Blockchain network","type":"string"},"tokenSymbol":{"description":"Token symbol (e.g. USDC)","type":"string"}},"required":["amount","tokenSymbol","blockchain"],"type":"object"},"InsufficientBalanceErrorBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"InsufficientBalanceError","type":"string"},"params":{"$ref":"#/components/schemas/InsufficientBalanceErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"InsufficientBalanceErrorBodyParams":{"properties":{"availableBalance":{"allOf":[{"$ref":"#/components/schemas/InsufficientBalanceAvailableBalance"}],"description":"Current available balance"},"payoutRequestId":{"description":"ID of the payout request","format":"uuid","type":"string"},"requiredAmount":{"description":"Required amount for the transaction","type":"string"}},"required":["requiredAmount","availableBalance","payoutRequestId"],"type":"object"},"InternalPassportGovernmentId":{"description":"Internal Passport (Russia) - typically single-sided","properties":{"countryCode":{"description":"Country Code of Internal Passport Issuer (ISO 3166-1 alpha-2) - Russia only","enum":["RU"],"example":"RU","title":"Country Code","type":"string"},"internalPassportBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of Internal Passport document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"internal_passport_back.pdf"},"title":"Internal Passport Back Document"},"internalPassportDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Internal Passport document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"internal_passport.pdf"},"title":"Internal Passport Document"},"internalPassportNumber":{"description":"Internal Passport Number","example":"IP12345678","title":"Internal Passport Number","type":"string"},"type":{"enum":["internalPassport"],"type":"string"}},"required":["type","internalPassportNumber","countryCode","internalPassportDocument"],"type":"object"},"InternalPassportIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"RU","type":"string"},"internalPassportDocumentId":{"description":"File ID (UUID) of the internal passport document, from the document upload endpoint.","format":"uuid","type":"string"},"internalPassportNumber":{"description":"Internal passport number","example":"123456789","type":"string"},"type":{"enum":["internalPassport"],"type":"string"}},"required":["type","countryCode","internalPassportNumber","internalPassportDocumentId"],"title":"Internal Passport","type":"object"},"KYCBusinessVerificationRequest":{"description":"KYC Business Verification Request","properties":{"businessDetails":{"allOf":[{"$ref":"#/components/schemas/BusinessDetails"}],"description":"Business Details","title":"Business Details"},"businessIdentificationInfo":{"allOf":[{"$ref":"#/components/schemas/BusinessIdentificationInfo"}],"description":"Business identification and registration information","title":"Business Identification Info"},"businessProofOfAddress":{"description":"Proof of address documents with filenames and base64 content","example":[{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"PROOF_OF_ADDRESS","filename":"utility_bill.pdf"},{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"PROOF_OF_ADDRESS","filename":"lease_agreement.pdf"}],"items":{"$ref":"#/components/schemas/DocumentUpload"},"title":"Business Proof of Address","type":"array"},"controlPerson":{"allOf":[{"$ref":"#/components/schemas/KYCIndividualVerificationRequest"}],"description":"Business Control Person Information","title":"Control Person"},"financialDetails":{"allOf":[{"$ref":"#/components/schemas/BusinessFinancialDetails"}],"description":"Financial Details","title":"Financial Details"},"flowOfFundsDoc":{"allOf":[{"$ref":"#/components/schemas/DocumentUpload"}],"description":"Flow of funds document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"FLOW_OF_FUNDS","filename":"flow_of_funds.pdf"},"title":"Flow of Funds Document"},"formationDocuments":{"description":"Business formation documents with filenames and base64 content","example":[{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"ARTICLES_OF_INCORPORATION","filename":"articles_of_incorporation.pdf"},{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"BUSINESS_LICENSE","filename":"business_license.pdf"}],"items":{"$ref":"#/components/schemas/DocumentUpload"},"title":"Business Formation Documents","type":"array"},"type":{"enum":["business"],"type":"string"},"uboOwnershipDocuments":{"description":"Mural is required to confirm the individual ultimate beneficial owners of the underlying entity. If there are no beneficial owners with 25% or more ownership, report the owner with the highest ownership percentage.\n\nBusiness ownership must be either attested by a control person or substantiated with an ownership document.\n\nKYC on all Beneficial Owners and/or Control Owners (per US or International requirements).\n\nAll Ultimate Beneficial Owners (UBO): Individual or entity that has ownership of a business, institution, or legal entity or Control Person (if different than the Ultimate Beneficial Owners): an individual with significant responsibility to control or direct business; typically an executive officer (CEO, CFO, COO, President).","example":[{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"OWNERSHIP_STRUCTURE","filename":"ownership_structure.pdf"},{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"SHAREHOLDER_REGISTRY","filename":"shareholder_agreement.pdf"}],"items":{"$ref":"#/components/schemas/DocumentUpload"},"title":"Business UBO Ownership Documents","type":"array"},"ultimateBeneficialOwners":{"description":"List of Beneficial Owners","items":{"$ref":"#/components/schemas/KYCIndividualVerificationRequest"},"title":"Business Ultimate Beneficial Owners","type":"array"}},"required":["type","businessIdentificationInfo","businessDetails","financialDetails","ultimateBeneficialOwners","formationDocuments","uboOwnershipDocuments","businessProofOfAddress"],"type":"object"},"KYCIndividualOrganizationVerificationRequest":{"description":"KYC Individual Verification Request V2","properties":{"individualFinancialInformation":{"allOf":[{"$ref":"#/components/schemas/IndividualFinancialInformation"}],"description":"Financial information for the individual organization","title":"Individual Financial Information"},"individualIdentityInfo":{"allOf":[{"$ref":"#/components/schemas/IndividualIdentityInfoV2"}],"description":"Identity verification information for the individual","title":"Individual Identity Info"},"individualPersonalInfo":{"allOf":[{"$ref":"#/components/schemas/IndividualPersonalInfoV2"}],"description":"Personal information about the individual","title":"Individual Personal Info"},"individualProofOfAddress":{"allOf":[{"$ref":"#/components/schemas/ProofOfAddressDocumentUpload"}],"description":"Proof of address document. Required for individuals residing in Austria, Belgium, Bulgaria, Croatia, Cyprus, Czechia, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Latvia, Liechtenstein, Lithuania, Luxembourg, Malta, Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden, or United Kingdom, OR for individuals who will conduct transactions in Euros, OR when the government ID country does not match the residential address country","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"PROOF_OF_ADDRESS","filename":"proof_of_address.pdf"},"title":"Individual Proof of Address"},"isPoliticallyExposed":{"description":"Whether the individual is a Politically Exposed Person","example":false,"title":"Politically Exposed Person Disclosure","type":"boolean"},"selfiePhoto":{"allOf":[{"$ref":"#/components/schemas/SelfiePhotoDocumentUpload"}],"description":"Selfie photo document. Required for individuals residing in Argentina (AR). Upload a clear, well-lit photo of the individual's face.","example":{"documentContent":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...","filename":"selfie.jpg"},"title":"Selfie Photo"},"type":{"enum":["individualV2"],"example":"individualV2","title":"Type","type":"string"}},"required":["type","individualIdentityInfo","individualPersonalInfo","isPoliticallyExposed","individualFinancialInformation"],"type":"object"},"KYCIndividualVerificationRequest":{"description":"KYC Individual Verification Request","properties":{"individualIdentityInfo":{"allOf":[{"$ref":"#/components/schemas/IndividualIdentityInfo"}],"description":"Identity verification information for the individual","title":"Individual Identity Info"},"individualPersonalInfo":{"allOf":[{"$ref":"#/components/schemas/IndividualPersonalInfo"}],"description":"Personal information about the individual","title":"Individual Personal Info"},"individualProofOfAddress":{"allOf":[{"$ref":"#/components/schemas/DocumentUpload"}],"description":"Proof of address document with filename and base64 content. Required for the full Know Your Business document set.","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","documentType":"PROOF_OF_ADDRESS","filename":"utility_bill.pdf"},"title":"Individual Proof of Address"},"pepDisclosure":{"default":false,"description":"Politically Exposed Person Disclosure","example":false,"title":"Politically Exposed Person Disclosure","type":"boolean"},"type":{"enum":["individual"],"type":"string"}},"required":["type","individualIdentityInfo","individualPersonalInfo","pepDisclosure"],"type":"object"},"KeypassIdGovernmentId":{"description":"Keypass ID (Australia) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Keypass ID Issuer (ISO 3166-1 alpha-2) - Australia only","enum":["AU"],"example":"AU","title":"Country Code","type":"string"},"keypassIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of Keypass ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"keypass_id_back.pdf"},"title":"Keypass ID Back Document"},"keypassIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of Keypass ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"keypass_id_front.pdf"},"title":"Keypass ID Front Document"},"keypassIdNumber":{"description":"Keypass ID Number","example":"KP12345678","title":"Keypass ID Number","type":"string"},"type":{"enum":["keypassId"],"type":"string"}},"required":["type","keypassIdNumber","countryCode","keypassIdFrontDocument","keypassIdBackDocument"],"type":"object"},"KeypassIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"AU","type":"string"},"keypassIdBackDocumentId":{"description":"File ID (UUID) of the back of the Keypass ID, from the document upload endpoint.","format":"uuid","type":"string"},"keypassIdFrontDocumentId":{"description":"File ID (UUID) of the front of the Keypass ID, from the document upload endpoint.","format":"uuid","type":"string"},"keypassIdNumber":{"description":"Keypass ID number","example":"K1234567","type":"string"},"type":{"enum":["keypassId"],"type":"string"}},"required":["type","countryCode","keypassIdNumber","keypassIdFrontDocumentId","keypassIdBackDocumentId"],"title":"Keypass ID","type":"object"},"KycLinkResponse":{"properties":{"expiresAt":{"description":"ISO 8601 timestamp when this KYC link will expire. After expiration, call this endpoint again to generate a new link.","example":"2024-01-15T12:00:00.000Z","format":"date-time","title":"Expires At","type":"string"},"kycLink":{"description":"URL to the KYC verification page for the organization. This link should be provided to the organization to complete their KYC verification.","example":"https://app.muralpay.com/verification/abc123-uuid","format":"url","title":"KYC Link","type":"string"}},"required":["kycLink","expiresAt"],"type":"object"},"KycUpgradeRequiredErrorBodyParams":{"properties":{"currentTier":{"description":"The tier the organization currently holds","enum":["LIGHT","STANDARD","US_STANDARD","FULL"],"type":"string"},"requiredTier":{"description":"The minimum tier required to perform the requested action","enum":["LIGHT","STANDARD","US_STANDARD","FULL"],"type":"string"}},"required":["currentTier","requiredTier"],"type":"object"},"KycUpgradeRequiredExceptionBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"KycUpgradeRequiredException","type":"string"},"params":{"$ref":"#/components/schemas/KycUpgradeRequiredErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"ListAssociatedPersonsResponse":{"properties":{"persons":{"description":"All associated persons for the organization.","items":{"$ref":"#/components/schemas/AssociatedPersonResource"},"type":"array"}},"required":["persons"],"type":"object"},"LongTermPassGovernmentId":{"description":"Long Term Pass (Singapore) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Long Term Pass Issuer (ISO 3166-1 alpha-2) - Singapore only","enum":["SG"],"example":"SG","title":"Country Code","type":"string"},"longTermPassBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of Long Term Pass document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"long_term_pass_back.pdf"},"title":"Long Term Pass Back Document"},"longTermPassFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of Long Term Pass document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"long_term_pass_front.pdf"},"title":"Long Term Pass Front Document"},"longTermPassNumber":{"description":"Long Term Pass Number","example":"LTP12345678","title":"Long Term Pass Number","type":"string"},"type":{"enum":["longTermPass"],"type":"string"}},"required":["type","longTermPassNumber","countryCode","longTermPassFrontDocument","longTermPassBackDocument"],"type":"object"},"LongTermPassIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"SG","type":"string"},"longTermPassBackDocumentId":{"description":"File ID (UUID) of the back of the long-term pass, from the document upload endpoint.","format":"uuid","type":"string"},"longTermPassFrontDocumentId":{"description":"File ID (UUID) of the front of the long-term pass, from the document upload endpoint.","format":"uuid","type":"string"},"longTermPassNumber":{"description":"Long-term pass number","example":"LTP1234567A","type":"string"},"type":{"enum":["longTermPass"],"type":"string"}},"required":["type","countryCode","longTermPassNumber","longTermPassFrontDocumentId","longTermPassBackDocumentId"],"title":"Long-Term Pass","type":"object"},"MXNDeveloperFee":{"properties":{"developerFeePercentage":{"description":"Developer fee percentage for MXN payins (0-100)","example":2,"maximum":100,"minimum":0,"type":"number"},"type":{"enum":["mxn"],"type":"string"}},"required":["type","developerFeePercentage"],"type":"object"},"MXNDomesticPayoutMethodDetails":{"properties":{"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_mxn_001","type":"string"},"symbol":{"enum":["MXN"],"type":"string"},"type":{"enum":["mxnDomestic"],"type":"string"}},"required":["type","symbol","bankAccountNumber","bankId"],"type":"object"},"MXNDomesticPayoutMethodResponseDetails":{"properties":{"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****4567","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_mxn_001","type":"string"},"symbol":{"enum":["MXN"],"type":"string"},"type":{"enum":["mxnDomestic"],"type":"string"}},"required":["type","symbol","bankId","bankAccountNumberTruncated"],"type":"object"},"MXNPayinRailDetails":{"properties":{"bankCode":{"description":"The bank code (first 3 digits of CLABE)","type":"string"},"bankName":{"description":"The name of the bank","type":"string"},"clabe":{"description":"CLABE - 18-digit account number for SPEI transfers","type":"string"},"currency":{"enum":["MXN"],"type":"string"},"payinRail":{"description":"The payment rail type for MXN deposits","enum":["SPEI"],"type":"string"},"type":{"enum":["mxn"],"type":"string"}},"required":["type","currency","payinRail","clabe","bankName","bankCode"],"type":"object"},"MXNPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/MXNDomesticPayoutMethodDetails","title":"MXN Domestic"}]},"type":{"enum":["mxn"],"type":"string"}},"required":["type","details"],"type":"object"},"MXNPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/MXNDomesticPayoutMethodResponseDetails","title":"MXN Domestic"}]},"type":{"enum":["mxn"],"type":"string"}},"required":["type","details"],"type":"object"},"MXNSpeiPayinAmount":{"description":"MXN amount in cents.","properties":{"currencySymbol":{"description":"Must be `MXN`.","enum":["MXN"],"example":"MXN","type":"string"},"value":{"description":"Amount in cents (e.g. `\"12345\"` = 123.45 MXN).","example":"12345","type":"string"}},"required":["currencySymbol","value"],"type":"object"},"MXNSpeiPayinCreationDetails":{"description":"Create an MXN SPEI bank-transfer pay-in.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/MXNSpeiPayinAmount"}],"description":"The amount the payer must send.","example":{"currencySymbol":"MXN","value":"12345"}},"expiresInSeconds":{"description":"Seconds until the pay-in expires. Default 86400 (1 day). Min 300 (5 min). Max 259200 (3 days).","maximum":259200,"minimum":300,"type":"integer"},"type":{"enum":["mxn-spei"],"type":"string"}},"required":["type","amount"],"type":"object"},"MXNSpeiPayinInstructions":{"description":"Pay-in instructions for an MXN SPEI bank transfer.","properties":{"bankAccountNumber":{"description":"CLABE the payer sends funds to.","type":"string"},"bankName":{"description":"Name of the receiving bank.","type":"string"},"expiresAt":{"description":"When the pay-in expires.","format":"date-time","type":"string"},"type":{"enum":["mxn-spei"],"type":"string"}},"required":["type","expiresAt","bankAccountNumber","bankName"],"type":"object"},"MissingAttestationsErrorBodyParams":{"properties":{"requiredAttestations":{"description":"Attestation types required to submit this tier","items":{"$ref":"#/components/schemas/AttestationRequirement"},"type":"array"},"reviewId":{"description":"The review that was submitted","format":"uuid","type":"string"},"tier":{"description":"The tier that was submitted","enum":["LIGHT","STANDARD","US_STANDARD","FULL"],"type":"string"},"uploadedAttestations":{"description":"Attestations already uploaded for this review","items":{"$ref":"#/components/schemas/AttestationSummaryParam"},"type":"array"}},"required":["reviewId","tier","requiredAttestations","uploadedAttestations"],"type":"object"},"MissingAttestationsExceptionBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"MissingAttestationsException","type":"string"},"params":{"$ref":"#/components/schemas/MissingAttestationsErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"MissingCounterpartyInformation":{"properties":{"counterpartyId":{"description":"ID of the counterparty referenced by the failing payout.","format":"uuid","type":"string"},"missingFields":{"description":"Names of recipient fields required for this payout's destination currency that are missing from the counterparty. Populate these on the counterparty (or use an existing counterparty that already has them) and retry.","example":["email"],"items":{"type":"string"},"type":"array"},"payoutMethodId":{"description":"ID of the saved payout method on the counterparty that the failing payout was targeting.","format":"uuid","type":"string"},"type":{"description":"Discriminator marking this failure as belonging to a saved counterparty referenced by the payout.","enum":["counterparty"],"type":"string"}},"required":["type","counterpartyId","payoutMethodId","missingFields"],"type":"object"},"MissingInlineRecipientInformation":{"properties":{"missingFields":{"description":"Names of recipient fields required for this payout's destination currency that are missing from the inline recipient. Populate these on the recipient and retry.","example":["email"],"items":{"type":"string"},"type":"array"},"type":{"description":"Discriminator marking this failure as belonging to an inline recipient (the payout's `recipientInfo` was sent inline rather than referenced by counterparty id).","enum":["inlineRecipient"],"type":"string"}},"required":["type","missingFields"],"type":"object"},"MunicipalIdGovernmentId":{"description":"Municipal ID (US) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Municipal ID Issuer (ISO 3166-1 alpha-2) - US only","example":"US","title":"Country Code","type":"string"},"municipalIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of Municipal ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"municipal_id_back.pdf"},"title":"Municipal ID Back Document"},"municipalIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of Municipal ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"municipal_id_front.pdf"},"title":"Municipal ID Front Document"},"municipalIdNumber":{"description":"Municipal ID Number","example":"MID12345678","title":"Municipal ID Number","type":"string"},"type":{"enum":["municipalId"],"type":"string"}},"required":["type","municipalIdNumber","countryCode","municipalIdFrontDocument","municipalIdBackDocument"],"type":"object"},"MunicipalIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"PH","type":"string"},"municipalIdBackDocumentId":{"description":"File ID (UUID) of the back of the municipal ID, from the document upload endpoint.","format":"uuid","type":"string"},"municipalIdFrontDocumentId":{"description":"File ID (UUID) of the front of the municipal ID, from the document upload endpoint.","format":"uuid","type":"string"},"municipalIdNumber":{"description":"Municipal ID number","example":"MUN-1234567","type":"string"},"type":{"enum":["municipalId"],"type":"string"}},"required":["type","countryCode","municipalIdNumber","municipalIdFrontDocumentId","municipalIdBackDocumentId"],"title":"Municipal ID","type":"object"},"MuralAccountDetails":{"properties":{"balancesV2":{"description":"The balances associated with the Account, including both blockchain token balances and fiat balances.","items":{"oneOf":[{"$ref":"#/components/schemas/BlockchainAmount","title":"Blockchain"},{"$ref":"#/components/schemas/FiatAmount","title":"Fiat"}]},"type":"array"},"depositAccount":{"allOf":[{"$ref":"#/components/schemas/DepositAccount"}],"deprecated":true,"description":"Deprecated in favor of payinMethods. Please use payinMethods going forward. The virtual account details for the Account. This will only be populated if the Account belongs to an Organization that has completed the appropriate KYC procedures. See specific KYC documentation for more details. "},"payinMethods":{"description":"The payin methods for the Account.","items":{"$ref":"#/components/schemas/PayinMethod"},"type":"array"},"walletDetails":{"$ref":"#/components/schemas/WalletDetails"}},"required":["walletDetails","balancesV2","payinMethods"],"type":"object"},"MuralCurrencyCapability":{"properties":{"currencyCode":{"enum":["USD","COP","ARS","EUR","MXN","BRL","CLP","PEN","BOB","CRC","ZAR"],"type":"string"},"depositStatus":{"description":"Indicates whether or not this organization supports funding mural accounts with this currency. Enabled and restricted are terminal statuses.","oneOf":[{"$ref":"#/components/schemas/TermsOfService"},{"$ref":"#/components/schemas/AwaitingKYC"},{"$ref":"#/components/schemas/Enabled"},{"$ref":"#/components/schemas/Rejected"},{"$ref":"#/components/schemas/Restricted"}]},"fiatAndRailCode":{"description":"The currency and if applicable, rail code.","enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"},"payOutStatus":{"description":"Indicates whether or not this organization supports sending or withdrawing from mural accounts with this currency. Enabled and restricted are terminal statuses.","oneOf":[{"$ref":"#/components/schemas/TermsOfService"},{"$ref":"#/components/schemas/AwaitingKYC"},{"$ref":"#/components/schemas/Enabled"},{"$ref":"#/components/schemas/Rejected"},{"$ref":"#/components/schemas/Restricted"}]}},"required":["fiatAndRailCode","currencyCode","depositStatus","payOutStatus"],"type":"object"},"MuralPayinBatchRecipient":{"properties":{"accountId":{"description":"UUID of the Mural account that receives funds.","type":"string","x-order":1},"amount":{"allOf":[{"$ref":"#/components/schemas/COPFiatAmount"}],"description":"Amount this recipient will receive.","x-order":2},"payinId":{"description":"UUID of the internal Mural payin created for this recipient. Null until distribution begins.","nullable":true,"type":"string","x-order":3}},"required":["accountId","amount"],"type":"object"},"MuralSearchPayoutRequestsInput":{"properties":{"filter":{"description":"Filter payouts. See the filter type for more details. An empty filter will result in all payouts being returned.","oneOf":[{"$ref":"#/components/schemas/PayoutStatusFilter"}]}},"type":"object"},"MuralTransactionPaginatedResponse":{"properties":{"nextId":{"description":"The next ID of the Transaction","type":"string"},"results":{"items":{"$ref":"#/components/schemas/Transaction"},"type":"array"},"total":{"description":"The total number of Transactions","type":"number"}},"required":["total","results"],"type":"object"},"MuralWebhook":{"properties":{"categories":{"description":"Event categories this webhook is subscribed to","items":{"enum":["MURAL_ACCOUNT_BALANCE_ACTIVITY","BUSINESS_VERIFICATION_STATUS","ORGANIZATION_TOS","PAYOUT_REQUEST","PAYIN","COMPLIANCE_REVIEW"],"type":"string"},"type":"array"},"createdAt":{"description":"When the webhook was created","format":"date-time","type":"string"},"id":{"description":"Unique webhook identifier","type":"string"},"publicKey":{"description":"ECDSA public key in PEM format for signature verification","type":"string"},"status":{"description":"Webhook status","enum":["DISABLED","ACTIVE"],"type":"string"},"updatedAt":{"description":"When the webhook was last updated","format":"date-time","type":"string"},"url":{"description":"Webhook endpoint URL","type":"string"},"version":{"description":"Webhook version for tracking changes","type":"number"}},"required":["id","version","url","publicKey","categories","status","createdAt","updatedAt"],"type":"object"},"MxnDetails":{"properties":{"bankAccountNumber":{"type":"string"},"symbol":{"enum":["MXN"],"type":"string"},"type":{"enum":["mxn"],"type":"string"}},"required":["type","symbol","bankAccountNumber"],"type":"object"},"MxnSpeiSenderMetadata":{"properties":{"accountNumber":{"description":"The sender's account number (CLABE)","type":"string"},"bankCode":{"description":"The bank identifier code (first 3 digits of CLABE)","type":"string"},"bankName":{"description":"The sender's bank name","type":"string"},"claveDeRastreo":{"description":"The SPEI tracking key (clave de rastreo)","type":"string"},"documentNumber":{"description":"The sender's document number (RFC)","type":"string"},"documentType":{"description":"The sender's document type","type":"string"},"senderName":{"description":"The sender's name","type":"string"},"sourceReference":{"description":"The source reference from the originating bank","type":"string"},"type":{"enum":["mxn_spei"],"type":"string"}},"required":["type"],"type":"object"},"MyNumberCardGovernmentId":{"description":"My Number Card (Japan) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of My Number Card Issuer (ISO 3166-1 alpha-2) - Japan only","enum":["JP"],"example":"JP","title":"Country Code","type":"string"},"myNumberCardBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of My Number Card document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"my_number_card_back.pdf"},"title":"My Number Card Back Document"},"myNumberCardFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of My Number Card document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"my_number_card_front.pdf"},"title":"My Number Card Front Document"},"myNumberCardNumber":{"description":"My Number Card Number","example":"123456789012","title":"My Number Card Number","type":"string"},"type":{"enum":["myNumberCard"],"type":"string"}},"required":["type","myNumberCardNumber","countryCode","myNumberCardFrontDocument","myNumberCardBackDocument"],"type":"object"},"MyNumberCardIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"JP","type":"string"},"myNumberCardBackDocumentId":{"description":"File ID (UUID) of the back of the My Number card, from the document upload endpoint.","format":"uuid","type":"string"},"myNumberCardFrontDocumentId":{"description":"File ID (UUID) of the front of the My Number card, from the document upload endpoint.","format":"uuid","type":"string"},"myNumberCardNumber":{"description":"My Number card number (individual number)","example":"123456789012","type":"string"},"type":{"enum":["myNumberCard"],"type":"string"}},"required":["type","countryCode","myNumberCardNumber","myNumberCardFrontDocumentId","myNumberCardBackDocumentId"],"title":"My Number Card","type":"object"},"NameFilter":{"description":"Filter based on the name of the Organization","properties":{"name":{"description":"The name of the Organization to filter by. This will be case insensitive and will match any organization that contains the filter value.","type":"string"},"type":{"enum":["name"],"type":"string"}},"required":["type","name"],"type":"object"},"NationalIdGovernmentId":{"description":"National ID - requires front and back documents","properties":{"countryCode":{"description":"Country Code of National ID Issuer (ISO 3166-1 alpha-2)","example":"US","title":"Country Code","type":"string"},"nationalIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of national ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"national_id_back.pdf"},"title":"National ID Back Document"},"nationalIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of national ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"national_id_front.pdf"},"title":"National ID Front Document"},"nationalIdNumber":{"description":"National ID Number","example":"N12345678","title":"National ID Number","type":"string"},"type":{"enum":["nationalId"],"type":"string"}},"required":["type","nationalIdNumber","countryCode","nationalIdFrontDocument","nationalIdBackDocument"],"type":"object"},"NationalIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"DE","type":"string"},"nationalIdBackDocumentId":{"description":"File ID (UUID) of the back of the national ID, from the document upload endpoint.","format":"uuid","type":"string"},"nationalIdFrontDocumentId":{"description":"File ID (UUID) of the front of the national ID, from the document upload endpoint.","format":"uuid","type":"string"},"nationalIdNumber":{"description":"National ID number","example":"A123456789","type":"string"},"type":{"enum":["nationalId"],"type":"string"}},"required":["type","countryCode","nationalIdNumber","nationalIdFrontDocumentId","nationalIdBackDocumentId"],"title":"National ID","type":"object"},"NbiClearanceGovernmentId":{"description":"NBI Clearance (Philippines) - typically single-sided","properties":{"countryCode":{"description":"Country Code of NBI Clearance Issuer (ISO 3166-1 alpha-2) - Philippines only","enum":["PH"],"example":"PH","title":"Country Code","type":"string"},"nbiClearanceDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"NBI Clearance document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"nbi_clearance.pdf"},"title":"NBI Clearance Document"},"nbiClearanceNumber":{"description":"NBI Clearance Number","example":"NBI12345678","title":"NBI Clearance Number","type":"string"},"type":{"enum":["nbiClearance"],"type":"string"}},"required":["type","nbiClearanceNumber","countryCode","nbiClearanceDocument"],"type":"object"},"NbiClearanceIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"PH","type":"string"},"nbiClearanceDocumentId":{"description":"File ID (UUID) of the NBI clearance document, from the document upload endpoint.","format":"uuid","type":"string"},"nbiClearanceNumber":{"description":"NBI clearance reference number","example":"NBI-20240101-00001","type":"string"},"type":{"enum":["nbiClearance"],"type":"string"}},"required":["type","countryCode","nbiClearanceNumber","nbiClearanceDocumentId"],"title":"NBI Clearance","type":"object"},"NewAccountInput":{"properties":{"description":{"description":"The description of the Account","type":"string"},"destinationToken":{"allOf":[{"$ref":"#/components/schemas/TokenWithBlockchain"}],"description":"Optional destination token and blockchain for the Account. This value is only relevant for fiat payin methods. If not provided, defaults to the organization's default token and blockchain.","title":"Destination Token"},"developerFees":{"allOf":[{"$ref":"#/components/schemas/SetDeveloperFeesRequest"}],"description":"Optional developer fees configuration for the account. Developer fees can only be configured for child organizations, so requests including this field must be made on behalf of a child organization using the `on-behalf-of` header. See developer fee documentation for more information","title":"Developer Fees"},"name":{"description":"The name of the Account","type":"string"}},"required":["name"],"type":"object"},"NewPayinRequest":{"properties":{"destinationMuralAccountId":{"description":"The mural account that you will receive the funds in","format":"uuid","type":"string"},"destinationToken":{"allOf":[{"$ref":"#/components/schemas/TokenWithBlockchain"}],"description":"The destination token that you will receive in your mural account"},"payinDetails":{"description":"The details of the payin creation","oneOf":[{"$ref":"#/components/schemas/COPPayinCreationDetails","title":"COP PSE Payin Creation Details"},{"$ref":"#/components/schemas/COPBreBPayinCreationDetails","title":"COP Bre-B Payin Creation Details"},{"$ref":"#/components/schemas/ARSBankTransferPayinCreationDetails","title":"ARS Bank Transfer Payin Creation Details"},{"$ref":"#/components/schemas/BRLPixPayinCreationDetails","title":"BRL Pix Payin Creation Details"},{"$ref":"#/components/schemas/MXNSpeiPayinCreationDetails","title":"MXN SPEI Payin Creation Details"}]}},"required":["destinationToken","destinationMuralAccountId","payinDetails"],"type":"object"},"NewPayoutRequestInput":{"properties":{"memo":{"maxLength":500,"type":"string"},"payouts":{"description":"The list of payouts to be made. Maximum of 350 payouts allowed.","items":{"$ref":"#/components/schemas/PayoutInfoInput","maxLength":350,"minLength":1},"type":"array"},"sourceAccountId":{"description":"The ID of the source account to be used for the payout","format":"uuid","type":"string"}},"required":["sourceAccountId","payouts"],"type":"object"},"NewThirdPartyUser":{"properties":{"email":{"description":"Email address of the approver","type":"string"},"name":{"description":"The name of the approver","type":"string"}},"required":["name","email"],"type":"object"},"OfwIdGovernmentId":{"description":"OFW ID (Philippines) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of OFW ID Issuer (ISO 3166-1 alpha-2) - Philippines only","enum":["PH"],"example":"PH","title":"Country Code","type":"string"},"ofwIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of OFW ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"ofw_id_back.pdf"},"title":"OFW ID Back Document"},"ofwIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of OFW ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"ofw_id_front.pdf"},"title":"OFW ID Front Document"},"ofwIdNumber":{"description":"OFW ID Number","example":"OFW12345678","title":"OFW ID Number","type":"string"},"type":{"enum":["ofwId"],"type":"string"}},"required":["type","ofwIdNumber","countryCode","ofwIdFrontDocument","ofwIdBackDocument"],"type":"object"},"OfwIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"PH","type":"string"},"ofwIdBackDocumentId":{"description":"File ID (UUID) of the back of the OFW ID, from the document upload endpoint.","format":"uuid","type":"string"},"ofwIdFrontDocumentId":{"description":"File ID (UUID) of the front of the OFW ID, from the document upload endpoint.","format":"uuid","type":"string"},"ofwIdNumber":{"description":"OFW ID number","example":"OFW1234567","type":"string"},"type":{"enum":["ofwId"],"type":"string"}},"required":["type","countryCode","ofwIdNumber","ofwIdFrontDocumentId","ofwIdBackDocumentId"],"title":"OFW ID","type":"object"},"OrganizationComplianceInfo":{"properties":{"tiers":{"description":"Active compliance reviews for this organization, one entry per tier. Empty if no compliance review exists.","items":{"$ref":"#/components/schemas/OrganizationComplianceTierInfo"},"type":"array"}},"required":["tiers"],"type":"object"},"OrganizationComplianceTierInfo":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ComplianceReviewTier"}],"description":"The KYC tier this review is for."}},"required":["type"],"type":"object"},"PENDomesticPayoutMethodDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_pen_001","type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["PEN"],"type":"string"},"type":{"enum":["penDomestic"],"type":"string"}},"required":["type","symbol","documentNumber","documentType","bankAccountNumber","accountType","bankId"],"type":"object"},"PENDomesticPayoutMethodResponseDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****9012","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_pen_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****5678","type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["PEN"],"type":"string"},"type":{"enum":["penDomestic"],"type":"string"}},"required":["type","symbol","documentType","accountType","bankId","documentNumberTruncated","bankAccountNumberTruncated"],"type":"object"},"PENPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/PENDomesticPayoutMethodDetails","title":"PEN Domestic"}]},"type":{"enum":["pen"],"type":"string"}},"required":["type","details"],"type":"object"},"PENPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/PENDomesticPayoutMethodResponseDetails","title":"PEN Domestic"}]},"type":{"enum":["pen"],"type":"string"}},"required":["type","details"],"type":"object"},"PaginatedResponse":{"properties":{"nextId":{"format":"uuid","type":"string"},"total":{"type":"number"}},"required":["total"],"type":"object"},"PanCardGovernmentId":{"description":"PAN Card (India) - typically single-sided","properties":{"countryCode":{"description":"Country Code of PAN Card Issuer (ISO 3166-1 alpha-2) - India only","enum":["IN"],"example":"IN","title":"Country Code","type":"string"},"panCardBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of PAN Card document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"pan_card_back.pdf"},"title":"PAN Card Back Document"},"panCardDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"PAN Card document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"pan_card.pdf"},"title":"PAN Card Document"},"panCardNumber":{"description":"PAN Card Number","example":"ABCDE1234F","title":"PAN Card Number","type":"string"},"type":{"enum":["panCard"],"type":"string"}},"required":["type","panCardNumber","countryCode","panCardDocument"],"type":"object"},"PanCardIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"IN","type":"string"},"panCardDocumentId":{"description":"File ID (UUID) of the PAN card document, from the document upload endpoint.","format":"uuid","type":"string"},"panCardNumber":{"description":"PAN card number","example":"ABCDE1234F","type":"string"},"type":{"enum":["panCard"],"type":"string"}},"required":["type","countryCode","panCardNumber","panCardDocumentId"],"title":"PAN Card","type":"object"},"PassportCardGovernmentId":{"description":"Passport card identification - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Passport Card Issuer (ISO 3166-1 alpha-2)","example":"US","title":"Passport Card Country Code","type":"string"},"passportCardBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of passport card document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"passport_card_back.pdf"},"title":"Passport Card Back Document"},"passportCardFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of passport card document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"passport_card_front.pdf"},"title":"Passport Card Front Document"},"passportCardNumber":{"description":"Passport Card Number","example":"C12345678","title":"Passport Card Number","type":"string"},"type":{"enum":["passportCard"],"type":"string"}},"required":["type","passportCardNumber","countryCode","passportCardFrontDocument","passportCardBackDocument"],"type":"object"},"PassportCardIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"US","type":"string"},"passportCardBackDocumentId":{"description":"File ID (UUID) of the back of the passport card, from the document upload endpoint.","format":"uuid","type":"string"},"passportCardFrontDocumentId":{"description":"File ID (UUID) of the front of the passport card, from the document upload endpoint.","format":"uuid","type":"string"},"passportCardNumber":{"description":"Passport card number","example":"C01234567","type":"string"},"type":{"enum":["passportCard"],"type":"string"}},"required":["type","countryCode","passportCardNumber","passportCardFrontDocumentId","passportCardBackDocumentId"],"title":"Passport Card","type":"object"},"PassportGovernmentId":{"description":"Passport identification - requires only front document (single-sided)","properties":{"countryCode":{"description":"Country Code of Passport Issuer (ISO 3166-1 alpha-2)","example":"US","title":"Country Code","type":"string"},"passportDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Passport document with filename and base64 content","example":{"documentContent":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD...","filename":"passport.jpeg"},"title":"Passport Document"},"passportNumber":{"description":"Passport Number","example":"P12345678","title":"Passport Number","type":"string"},"type":{"enum":["passport"],"type":"string"}},"required":["type","passportNumber","countryCode","passportDocument"],"type":"object"},"PassportIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"US","type":"string"},"passportDocumentId":{"description":"File ID (UUID) of the passport document, from the document upload endpoint.","format":"uuid","type":"string"},"passportNumber":{"description":"Passport number","example":"A12345678","type":"string"},"type":{"enum":["passport"],"type":"string"}},"required":["type","countryCode","passportNumber","passportDocumentId"],"title":"Passport","type":"object"},"Payin":{"properties":{"id":{"format":"uuid","type":"string","x-order":1},"destinationAccountId":{"description":"The ID of the mural account that the payin is being sent to.","format":"uuid","type":"string","x-order":2},"payinRail":{"description":"The payment rail used for this payin.","enum":["ACH","WIRE","SEPA","MXN_SPEI","BRL_PIX","ARS_CVU","COP_PSE","COP_BREB","BLOCKCHAIN"],"type":"string","x-order":3},"payinStatus":{"description":"The status of the payin.","oneOf":[{"$ref":"#/components/schemas/PayinCreatedStatus","title":"Payin Created Status"},{"$ref":"#/components/schemas/PayinCanceledStatus","title":"Payin Canceled Status"},{"$ref":"#/components/schemas/PayinPendingStatus","title":"Payin Pending Status"},{"$ref":"#/components/schemas/PayinOnHoldStatus","title":"Payin On Hold Status"},{"$ref":"#/components/schemas/PayinCompletedStatus","title":"Payin Completed Status"},{"$ref":"#/components/schemas/PayinFailedStatus","title":"Payin Failed Status"}],"x-order":4},"sourceAmount":{"description":"The amount sent by the payer, in the source currency.","example":{"currencySymbol":"USD","exponent":2,"type":"fiat","value":"10000"},"oneOf":[{"$ref":"#/components/schemas/PayinFiatAmount","title":"Fiat"},{"$ref":"#/components/schemas/PayinSourceBlockchainAmount","title":"Blockchain"}],"x-order":5},"settlementStrategy":{"description":"The settlement strategy applied to this payin — whether funds are held as a fiat balance in the account or automatically converted to the Account's destination token on settlement.","oneOf":[{"$ref":"#/components/schemas/HoldInFiatSettlementStrategy","title":"Hold In Fiat"},{"$ref":"#/components/schemas/AutoOnrampSettlementStrategy","title":"Auto On-Ramp"}],"x-order":6},"settlementDetails":{"description":"Where the funds are going (pre-settlement) or landed (post-settlement).","oneOf":[{"$ref":"#/components/schemas/FiatSettlementDetails","title":"Fiat"},{"$ref":"#/components/schemas/BlockchainSettlementDetails","title":"Blockchain"}],"x-order":7},"fees":{"allOf":[{"$ref":"#/components/schemas/PayinFees"}],"description":"Breakdown of all fees applied to this payin.","x-order":8},"payinInstructions":{"description":"The instructions for the payin.","oneOf":[{"$ref":"#/components/schemas/COPPayinInstructions","title":"COP PSE Payin Instructions"},{"$ref":"#/components/schemas/COPBreBPayinInstructions","title":"COP Bre-B Payin Instructions"},{"$ref":"#/components/schemas/ARSBankTransferPayinInstructions","title":"ARS Bank Transfer Payin Instructions"},{"$ref":"#/components/schemas/BRLPixPayinInstructions","title":"BRL Pix Payin Instructions"},{"$ref":"#/components/schemas/MXNSpeiPayinInstructions","title":"MXN SPEI Payin Instructions"}],"x-order":9},"exchangeRate":{"description":"The exchange rate used for this payin. Multiply the fiat payin amount by this rate to get the equivalent token amount. Only present for non-USD payins.","type":"number","x-order":10},"createdAt":{"description":"The date and time the payin was created.","format":"date-time","type":"string","x-order":11},"updatedAt":{"description":"The date and time the payin was last updated.","format":"date-time","type":"string","x-order":12},"payinBatchId":{"description":"If this payin was created as part of a batch payin, the ID of the PayinBatch.","format":"uuid","nullable":true,"type":"string","x-order":13}},"required":["id","destinationAccountId","payinRail","payinStatus","sourceAmount","settlementStrategy","settlementDetails","fees","createdAt","updatedAt"],"type":"object"},"PayinAchSenderMetadata":{"description":"Sender metadata for ACH-originated payins.","properties":{"achRoutingNumber":{"description":"The ACH routing number of the sender.","type":"string"},"description":{"description":"The description of the transaction","type":"string"},"senderName":{"description":"The name of the sender","type":"string"},"type":{"enum":["ach"],"type":"string"}},"required":["type","senderName"],"type":"object"},"PayinBatchAwaitingSourcePayinStatus":{"properties":{"fundingInstructions":{"allOf":[{"$ref":"#/components/schemas/PayinBatchFundingInstructions"}],"description":"Instructions for funding this batch.","x-order":2},"type":{"enum":["awaitingSourcePayin"],"type":"string"}},"required":["type","fundingInstructions"],"type":"object"},"PayinBatchCompletedStatus":{"properties":{"type":{"enum":["completedBatchPayins"],"type":"string"}},"required":["type"],"type":"object"},"PayinBatchDistributingRecipientPayinsStatus":{"properties":{"type":{"enum":["distributingRecipientPayins"],"type":"string"}},"required":["type"],"type":"object"},"PayinBatchFundingInstructions":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/COPFiatAmount"}],"description":"The exact amount the client must send.","x-order":1},"bankAccount":{"description":"Bank account to send funds to.","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/COPFundingBankAccount"}],"x-order":2}},"required":["amount","bankAccount"],"type":"object"},"PayinBatchSourcePayinReceivedStatus":{"properties":{"type":{"enum":["sourcePayinReceived"],"type":"string"}},"required":["type"],"type":"object"},"PayinCanceledStatus":{"properties":{"senderMetadata":{"description":"Rail-specific sender metadata.","oneOf":[{"$ref":"#/components/schemas/PayinAchSenderMetadata","title":"ACH"},{"$ref":"#/components/schemas/WireSenderMetadata","title":"Wire"},{"$ref":"#/components/schemas/BlockchainSenderMetadata","title":"Blockchain"},{"$ref":"#/components/schemas/COPBreBSenderMetadata","title":"COP Bre-B"},{"$ref":"#/components/schemas/ARSBankTransferSenderMetadata","title":"ARS Bank Transfer"},{"$ref":"#/components/schemas/UnknownSenderMetadata","title":"Unknown"}]},"type":{"enum":["canceled"],"type":"string"}},"required":["type","senderMetadata"],"type":"object"},"PayinCompletedStatus":{"properties":{"completedAt":{"description":"The date and time the payin was completed.","format":"date-time","type":"string"},"initiatedAt":{"description":"The date and time the payin was initiated.","format":"date-time","type":"string"},"senderMetadata":{"description":"Rail-specific sender metadata.","oneOf":[{"$ref":"#/components/schemas/PayinAchSenderMetadata","title":"ACH"},{"$ref":"#/components/schemas/WireSenderMetadata","title":"Wire"},{"$ref":"#/components/schemas/BlockchainSenderMetadata","title":"Blockchain"},{"$ref":"#/components/schemas/COPBreBSenderMetadata","title":"COP Bre-B"},{"$ref":"#/components/schemas/ARSBankTransferSenderMetadata","title":"ARS Bank Transfer"},{"$ref":"#/components/schemas/UnknownSenderMetadata","title":"Unknown"}]},"type":{"enum":["completed"],"type":"string"}},"required":["type","initiatedAt","completedAt","senderMetadata"],"type":"object"},"PayinCreatedStatus":{"properties":{"type":{"enum":["created"],"type":"string"}},"required":["type"],"type":"object"},"PayinExchangeRate":{"properties":{"destinationToken":{"allOf":[{"$ref":"#/components/schemas/TokenWithBlockchain"}],"description":"The destination token for the payin."},"exchangeRate":{"description":"The exchange rate for the payin.","type":"number"},"sourceCurrency":{"description":"The source currency for the payin.","enum":["USD","COP","ARS","EUR","MXN","BRL","CLP","PEN","BOB","CRC","ZAR"],"type":"string"}},"required":["exchangeRate","sourceCurrency","destinationToken"],"type":"object"},"PayinFailedStatus":{"properties":{"initiatedAt":{"description":"The date and time the payin was initiated.","format":"date-time","type":"string"},"reason":{"description":"The reason the payin failed.","type":"string"},"senderMetadata":{"description":"Rail-specific sender metadata.","oneOf":[{"$ref":"#/components/schemas/PayinAchSenderMetadata","title":"ACH"},{"$ref":"#/components/schemas/WireSenderMetadata","title":"Wire"},{"$ref":"#/components/schemas/BlockchainSenderMetadata","title":"Blockchain"},{"$ref":"#/components/schemas/COPBreBSenderMetadata","title":"COP Bre-B"},{"$ref":"#/components/schemas/ARSBankTransferSenderMetadata","title":"ARS Bank Transfer"},{"$ref":"#/components/schemas/UnknownSenderMetadata","title":"Unknown"}]},"type":{"enum":["failed"],"type":"string"}},"required":["type","initiatedAt","reason","senderMetadata"],"type":"object"},"PayinFeeItemization":{"properties":{"developerFee":{"description":"The portion collected by Mural and remitted to the developer, computed as a percentage of `sourceAmount`. Zero for organizations without a configured developer fee.","example":{"currencySymbol":"USD","exponent":2,"type":"fiat","value":"50"},"oneOf":[{"$ref":"#/components/schemas/FiatAmount","title":"Fiat"}]},"fixedTransactionFee":{"description":"Flat per-transaction fee for the rail. Applied regardless of `sourceAmount`.","example":{"currencySymbol":"USD","exponent":2,"type":"fiat","value":"25"},"oneOf":[{"$ref":"#/components/schemas/FiatAmount","title":"Fiat"}]},"variableFee":{"description":"Variable fee component, computed as a percentage of `sourceAmount`.","example":{"currencySymbol":"USD","exponent":2,"type":"fiat","value":"100"},"oneOf":[{"$ref":"#/components/schemas/FiatAmount","title":"Fiat"}]}},"required":["variableFee","developerFee","fixedTransactionFee"],"type":"object"},"PayinFees":{"properties":{"feeTotal":{"description":"Aggregate fee deducted from `sourceAmount`. Equals the sum of all components in `itemizedFees`. Subtract from `sourceAmount` to derive the amount converted into the destination currency.","example":{"currencySymbol":"USD","exponent":2,"type":"fiat","value":"175"},"oneOf":[{"$ref":"#/components/schemas/FiatAmount","title":"Fiat"}]},"itemizedFees":{"allOf":[{"$ref":"#/components/schemas/PayinFeeItemization"}],"description":"Itemized absolute fee amounts that sum to `feeTotal`.","title":"Itemized Fees"}},"required":["feeTotal","itemizedFees"],"type":"object"},"PayinFiatAmount":{"properties":{"type":{"enum":["fiat"],"type":"string","x-order":1},"currencySymbol":{"description":"The ISO 4217 currency code.","enum":["USD","EUR","MXN","BRL","COP","ARS"],"type":"string","x-order":2},"exponent":{"description":"The number of decimal places used by the smallest unit of the currency.","example":2,"type":"number","x-order":3},"value":{"description":"The amount in the smallest unit of the currency, as a string to preserve precision (e.g., for USD with exponent 2, \"2500\" represents $25.00).","example":"2500","type":"string","x-order":4}},"required":["type","currencySymbol","exponent","value"],"type":"object"},"PayinMethod":{"properties":{"payinRailDetails":{"oneOf":[{"$ref":"#/components/schemas/USDPayinRailDetails","title":"USD"},{"$ref":"#/components/schemas/EURPayinRailDetails","title":"EUR"},{"$ref":"#/components/schemas/COPPayinRailDetails","title":"COP-PSE"},{"$ref":"#/components/schemas/COPBreBPayinRailDetails","title":"COP-BRE-B"},{"$ref":"#/components/schemas/BlockchainDepositPayinRailDetails","title":"Blockchain"},{"$ref":"#/components/schemas/MXNPayinRailDetails","title":"MXN"},{"$ref":"#/components/schemas/BRLPayinRailDetails","title":"BRL"},{"$ref":"#/components/schemas/ARSPayinRailDetails","title":"ARS"}]},"status":{"description":"The status of the payin method.","enum":["ACTIVATED","DEACTIVATED"],"type":"string"},"supportedDestinationTokens":{"description":"The destination tokens that the payin fiat can be converted to","items":{"$ref":"#/components/schemas/PayinTokenDetails"},"type":"array"}},"required":["status","supportedDestinationTokens","payinRailDetails"],"type":"object"},"PayinMethodFees":{"properties":{"developerFeePercentage":{"description":"Developer fee percentage for the payin, applied to the payin fiat currency amount. A value of 2.5 should be viewed as 2.5%","type":"number"},"fixedTransactionFee":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"The fixed fee for the transaction for the payin (in the fiat currency of the payin method)"},"variableFeePercentage":{"description":"Total variable fee percentage for the payin, applied to the payin fiat currency amount. A value of 0.1 should be viewed as 0.1%","type":"number"}},"required":["variableFeePercentage"],"type":"object"},"PayinMinimumNotMetErrorBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"PayinMinimumNotMetError","type":"string"},"params":{"$ref":"#/components/schemas/PayoutMinimumNotMetErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"PayinOnHoldStatus":{"properties":{"initiatedAt":{"description":"The date and time the payin was initiated.","format":"date-time","type":"string"},"senderMetadata":{"description":"Rail-specific sender metadata.","oneOf":[{"$ref":"#/components/schemas/PayinAchSenderMetadata","title":"ACH"},{"$ref":"#/components/schemas/WireSenderMetadata","title":"Wire"},{"$ref":"#/components/schemas/BlockchainSenderMetadata","title":"Blockchain"},{"$ref":"#/components/schemas/COPBreBSenderMetadata","title":"COP Bre-B"},{"$ref":"#/components/schemas/ARSBankTransferSenderMetadata","title":"ARS Bank Transfer"},{"$ref":"#/components/schemas/UnknownSenderMetadata","title":"Unknown"}]},"type":{"enum":["on-hold"],"type":"string"}},"required":["type","initiatedAt","senderMetadata"],"type":"object"},"PayinPendingStatus":{"properties":{"initiatedAt":{"description":"The date and time the payin was initiated.","format":"date-time","type":"string"},"senderMetadata":{"description":"Rail-specific sender metadata.","oneOf":[{"$ref":"#/components/schemas/PayinAchSenderMetadata","title":"ACH"},{"$ref":"#/components/schemas/WireSenderMetadata","title":"Wire"},{"$ref":"#/components/schemas/BlockchainSenderMetadata","title":"Blockchain"},{"$ref":"#/components/schemas/COPBreBSenderMetadata","title":"COP Bre-B"},{"$ref":"#/components/schemas/ARSBankTransferSenderMetadata","title":"ARS Bank Transfer"},{"$ref":"#/components/schemas/UnknownSenderMetadata","title":"Unknown"}]},"type":{"enum":["pending"],"type":"string"}},"required":["type","initiatedAt","senderMetadata"],"type":"object"},"PayinSourceBlockchainAmount":{"properties":{"type":{"enum":["blockchain"],"type":"string","x-order":1},"tokenSymbol":{"description":"The token symbol.","enum":["USDC","USDT"],"type":"string","x-order":2},"exponent":{"description":"The number of decimal places used by the smallest unit of the token.","example":6,"type":"number","x-order":3},"value":{"description":"The token amount in its smallest unit, as a string to preserve precision.","example":"2500000","type":"string","x-order":4},"blockchain":{"description":"The blockchain network the payer sent the token from.","enum":["TRON","SOLANA"],"type":"string","x-order":5}},"required":["type","tokenSymbol","exponent","value","blockchain"],"type":"object"},"PayinTokenDetails":{"properties":{"fees":{"allOf":[{"$ref":"#/components/schemas/PayinMethodFees"}],"description":"The fees for the payin method."},"token":{"allOf":[{"$ref":"#/components/schemas/TokenWithBlockchain"}],"description":"The token for which the fees are being calculated."},"transactionMinimum":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"The minimum transaction amount for the payin (In the fiat currency of the payin method)"}},"required":["fees","token"],"type":"object"},"PayoutCanceledStatus":{"description":"Status when the transaction wasn't initiated because the sender canceled the transaction. This is a terminal status.","properties":{"type":{"enum":["canceled"],"type":"string"}},"required":["type"],"type":"object"},"PayoutCompletedStatus":{"description":"Status when the transaction has been executed and the payout is completed. The funds have been received by the recipient. This is a terminal status.","properties":{"completedAt":{"format":"date-time","type":"string"},"initiatedAt":{"description":"The time at which thepayout was initiated with the local banking provider","format":"date-time","type":"string"},"type":{"enum":["completed"],"type":"string"}},"required":["type","completedAt","initiatedAt"],"type":"object"},"PayoutComplianceValidationFailedErrorBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"PayoutComplianceValidationFailedError","type":"string"},"params":{"$ref":"#/components/schemas/PayoutComplianceValidationFailedErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"PayoutComplianceValidationFailedErrorBodyParams":{"properties":{"complianceFailures":{"description":"List of payouts that failed compliance validation, with failure details","items":{"$ref":"#/components/schemas/ComplianceValidationPayoutFailure"},"type":"array"}},"required":["complianceFailures"],"type":"object"},"PayoutCreatedStatus":{"description":"Status when the transaction hasn't been executed yet and the payout is created. This is the initial status of a fiat payout.","properties":{"type":{"enum":["created"],"type":"string"}},"required":["type"],"type":"object"},"PayoutExchangeRateChange":{"properties":{"fiatCurrencyCode":{"description":"Fiat currency code of the payout","type":"string"},"newExchangeRate":{"description":"1 USD equivalent in the destination fiat currency (new)","type":"number"},"newFiatAmount":{"description":"New fiat amount after exchange rate update","type":"number"},"payoutId":{"description":"ID of the affected payout","format":"uuid","type":"string"},"previousExchangeRate":{"description":"1 USD equivalent in the destination fiat currency (previous)","type":"number"},"previousFiatAmount":{"description":"Previous fiat amount","type":"number"}},"required":["fiatCurrencyCode","previousExchangeRate","newExchangeRate","previousFiatAmount","newFiatAmount","payoutId"],"type":"object"},"PayoutFailedStatus":{"description":"DEPRECATED: Status when the transaction has been initiated but the payout has failed. This is a terminal status. Reach out to Mural support","properties":{"errorCode":{"description":"Error code categorizing the failure reason","enum":["UNKNOWN","ACCOUNT_NUMBER_INCORRECT","REJECTED_BY_BANK","ACCOUNT_TYPE_INCORRECT","ACCOUNT_CLOSED","BENEFICIARY_DOCUMENTATION_INCORRECT"],"type":"string"},"initiatedAt":{"description":"The time at which thepayout was initiated with the local banking provider","format":"date-time","type":"string"},"reason":{"type":"string"},"type":{"enum":["failed"],"type":"string"}},"required":["type","reason","errorCode","initiatedAt"],"type":"object"},"PayoutFeeErrorReason":{"description":"Why the fee could not be quoted. Only a temporarily unavailable payout is worth retrying.","enum":["UNSUPPORTED_PAYOUT_RAIL","TEMPORARILY_UNAVAILABLE"],"type":"string"},"PayoutInfoInput":{"description":"Information for the specific payout to be made.","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"deprecated":true,"description":"The source token amount to be paid out (legacy, source-denominated only). Must have at most 2 decimal places. Provide exactly one of `amount` or `amountV2`. Prefer `amountV2` for new integrations."},"amountV2":{"description":"The payout amount, denominated by either the source (`sourceAmount`) or the fiat the recipient receives (`targetAmount`). Provide exactly one of `amount` (legacy, source-only) or `amountV2`.","discriminator":{"mapping":{"sourceAmount":"#/components/schemas/SourceAmount","targetAmount":"#/components/schemas/TargetAmount"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/SourceAmount","title":"Source Amount"},{"$ref":"#/components/schemas/TargetAmount","title":"Target Amount"}]},"payoutDetails":{"oneOf":[{"$ref":"#/components/schemas/FiatPayoutDetails","title":"Inline Fiat"},{"$ref":"#/components/schemas/BlockchainPayoutDetails","title":"Inline Blockchain Wallet"},{"$ref":"#/components/schemas/CounterpartyPayoutMethodDetails","title":"Counterparty Payout Method"}]},"recipientInfo":{"oneOf":[{"$ref":"#/components/schemas/IndividualRecipientInfo","title":"Inline Individual"},{"$ref":"#/components/schemas/BusinessRecipientInfo","title":"Inline Business"},{"$ref":"#/components/schemas/CounterpartyRecipientInfo","title":"Counterparty"}]},"supportingDetails":{"allOf":[{"$ref":"#/components/schemas/PayoutSupportingDetails"}],"description":"Supporting information for the payout. See \"Supporting Details Requirements\" in the Compliance Requirements section on the Guides page for more information on when this information is required."}},"required":["payoutDetails","recipientInfo"],"type":"object"},"PayoutMetadata":{"description":"Payout made inside of the platform","properties":{"payoutId":{"description":"The payout ID","format":"uuid","type":"string"},"payoutRequestId":{"description":"The payout request ID","format":"uuid","type":"string"},"type":{"enum":["payout"],"type":"string"}},"required":["type","payoutRequestId","payoutId"],"type":"object"},"PayoutMethodAliasFilter":{"description":"Filter payout methods by exact alias (case-insensitive).","properties":{"alias":{"description":"The alias to match.","maxLength":255,"minLength":1,"type":"string"},"type":{"enum":["alias"],"type":"string"}},"required":["type","alias"],"type":"object"},"PayoutMethodErrorBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"PayoutMethodError","type":"string"},"params":{"$ref":"#/components/schemas/PayoutMethodErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"PayoutMethodErrorBodyParams":{"properties":{"payoutMethodErrorReason":{"description":"Reason the payout method is in an error state","enum":["DISABLED_BY_PROVIDER"],"type":"string"},"payoutMethodId":{"description":"ID of the payout method in error state","format":"uuid","type":"string"}},"required":["payoutMethodId","payoutMethodErrorReason"],"type":"object"},"PayoutMethodPaginatedResponse":{"properties":{"nextId":{"description":"Cursor for fetching the next page of results","format":"uuid","type":"string"},"results":{"description":"List of payout methods","items":{"$ref":"#/components/schemas/PayoutMethodResponse"},"type":"array"},"total":{"description":"Total number of payout methods matching the filter","type":"number"}},"required":["total","results"],"type":"object"},"PayoutMethodResponse":{"properties":{"alias":{"description":"Internal user-friendly alias name for this payout method","type":"string"},"counterpartyId":{"description":"ID of the counterparty this payout method belongs to","format":"uuid","type":"string"},"createdAt":{"description":"Timestamp when the payout method was created","format":"date-time","type":"string"},"id":{"description":"Unique identifier for the payout method","format":"uuid","type":"string"},"payoutMethod":{"description":"Payout method details including type and payment information","oneOf":[{"$ref":"#/components/schemas/USDPayoutMethodInfo","title":"USD"},{"$ref":"#/components/schemas/ARSPayoutMethodInfo","title":"ARS"},{"$ref":"#/components/schemas/BRLPayoutMethodInfo","title":"BRL"},{"$ref":"#/components/schemas/COPPayoutMethodInfo","title":"COP"},{"$ref":"#/components/schemas/EURPayoutMethodInfo","title":"EUR"},{"$ref":"#/components/schemas/MXNPayoutMethodInfo","title":"MXN"},{"$ref":"#/components/schemas/CLPPayoutMethodInfo","title":"CLP"},{"$ref":"#/components/schemas/PENPayoutMethodInfo","title":"PEN"},{"$ref":"#/components/schemas/BOBPayoutMethodInfo","title":"BOB"},{"$ref":"#/components/schemas/CRCPayoutMethodInfo","title":"CRC"},{"$ref":"#/components/schemas/ZARPayoutMethodInfo","title":"ZAR"},{"$ref":"#/components/schemas/BlockchainPayoutMethodInfo","title":"Blockchain Wallet"}]}},"required":["id","createdAt","counterpartyId","alias","payoutMethod"],"type":"object"},"PayoutMinimumNotMetErrorBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"PayoutMinimumNotMetError","type":"string"},"params":{"$ref":"#/components/schemas/PayoutMinimumNotMetErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"PayoutMinimumNotMetErrorBodyParams":{"properties":{"exchangeRate":{"description":"Exchange rate applied, if applicable","type":"number"},"fees":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"Fees applied to the payout"},"minimumFiatAmount":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"Minimum fiat amount required"},"providedFiatAmount":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"Fiat amount that was provided"}},"required":["minimumFiatAmount","providedFiatAmount","fees"],"type":"object"},"PayoutOnHoldStatus":{"description":"Status when the transaction has been initiated and the payout is on hold. Review of the transaction is being conducted and the Mural team will reach out if more information is needed.","properties":{"initiatedAt":{"description":"The time at which thepayout was initiated with the local banking provider","format":"date-time","type":"string"},"type":{"enum":["on-hold"],"type":"string"}},"required":["type","initiatedAt"],"type":"object"},"PayoutPendingStatus":{"description":"Status when the transaction has been initiated and the payout is pending. The funds have been transferred to the provider and payout is being processed.","properties":{"initiatedAt":{"description":"The time at which thepayout was initiated with the local banking provider","format":"date-time","type":"string"},"type":{"enum":["pending"],"type":"string"}},"required":["type","initiatedAt"],"type":"object"},"PayoutQuoteExpiredErrorBodyParams":{"properties":{"expiredQuotes":{"description":"List of payouts whose exchange rate quotes have expired and been updated","items":{"$ref":"#/components/schemas/PayoutExchangeRateChange"},"type":"array"}},"required":["expiredQuotes"],"type":"object"},"PayoutQuoteExpiredExceptionBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"PayoutQuoteExpiredException","type":"string"},"params":{"$ref":"#/components/schemas/PayoutQuoteExpiredErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"PayoutRefundInProgressStatus":{"description":"Status when a refund has been initiated for a previously failed payout. The refund is currently being processed.","properties":{"errorCode":{"description":"Error code categorizing the failure reason that led to the refund","enum":["UNKNOWN","ACCOUNT_NUMBER_INCORRECT","REJECTED_BY_BANK","ACCOUNT_TYPE_INCORRECT","ACCOUNT_CLOSED","BENEFICIARY_DOCUMENTATION_INCORRECT"],"type":"string"},"failureReason":{"description":"The reason why the payout is being refunded","type":"string"},"initiatedAt":{"description":"The time at which thepayout was initiated with the local banking provider","format":"date-time","type":"string"},"refundInitiatedAt":{"description":"When the refund process was initiated","format":"date-time","type":"string"},"type":{"enum":["refundInProgress"],"type":"string"}},"required":["type","failureReason","errorCode","initiatedAt","refundInitiatedAt"],"type":"object"},"PayoutRefundedStatus":{"description":"Status when a payout has been successfully refunded. The funds have been returned to the sender. This is a terminal status.","properties":{"errorCode":{"description":"Error code categorizing the failure reason that led to the refund","enum":["UNKNOWN","ACCOUNT_NUMBER_INCORRECT","REJECTED_BY_BANK","ACCOUNT_TYPE_INCORRECT","ACCOUNT_CLOSED","BENEFICIARY_DOCUMENTATION_INCORRECT"],"type":"string"},"failureReason":{"description":"The reason why the payout was refunded","type":"string"},"initiatedAt":{"description":"The time at which thepayout was initiated with the local banking provider","format":"date-time","type":"string"},"refundCompletedAt":{"description":"When the refund was completed and funds returned","format":"date-time","type":"string"},"refundInitiatedAt":{"description":"When the refund process was initiated","format":"date-time","type":"string"},"refundTransactionId":{"description":"The transaction ID of the refund in the Transactions API","format":"uuid","type":"string"},"type":{"enum":["refunded"],"type":"string"}},"required":["type","refundTransactionId","failureReason","errorCode","initiatedAt","refundInitiatedAt","refundCompletedAt"],"type":"object"},"PayoutRequest":{"properties":{"createdAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"memo":{"type":"string"},"payouts":{"description":"Information associated with each recipient's payout included in the original payout request.","items":{"$ref":"#/components/schemas/PayoutRequestRecipientInfo"},"type":"array"},"sourceAccountId":{"format":"uuid","type":"string"},"status":{"deprecated":true,"description":"DEPRECATED: use `statusV2` instead. The status of the overall payout request. The initial status is AWAITING_EXECUTION, and the status will change to PENDING. EXECUTED, FAILED, and CANCELED are terminal statuses. EXECUTED indicates the blockchain transaction associated with the entire payout has been executed, but that does not mean your recipients have received funds. Check the individual recipientsPayoutDetails for the status of each recipient.","enum":["AWAITING_EXECUTION","CANCELED","PENDING","EXECUTED","FAILED"],"type":"string"},"statusV2":{"description":"The initial status is `awaitingExecution`, and the status will change to `pending`. `executed`, `failed`, and `canceled` are terminal statuses. `executed` indicates the blockchain transaction associated with the entire payout has been executed, but that does not mean your recipients have received funds. Check the individual recipientsPayoutDetails for the status of each recipient.","oneOf":[{"$ref":"#/components/schemas/PayoutRequestAwaitingExecutionStatusV2","title":"Awaiting Execution"},{"$ref":"#/components/schemas/PayoutRequestPendingStatusV2","title":"Pending"},{"$ref":"#/components/schemas/PayoutRequestExecutedStatusV2","title":"Executed"},{"$ref":"#/components/schemas/PayoutRequestFailedStatusV2","title":"Failed"},{"$ref":"#/components/schemas/PayoutRequestCanceledStatusV2","title":"Canceled"}]},"transactionHash":{"description":"The transaction hash of the blockchain transaction. Present when the status is EXECUTED.","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","createdAt","updatedAt","sourceAccountId","status","statusV2","payouts"],"type":"object"},"PayoutRequestAwaitingExecutionStatusV2":{"properties":{"type":{"enum":["awaitingExecution"],"type":"string"}},"required":["type"],"type":"object"},"PayoutRequestCanceledStatusV2":{"properties":{"type":{"enum":["canceled"],"type":"string"}},"required":["type"],"type":"object"},"PayoutRequestExecutedStatusV2":{"properties":{"type":{"enum":["executed"],"type":"string"}},"required":["type"],"type":"object"},"PayoutRequestFailedStatusV2":{"description":"Status metadata for a failed payout request.","properties":{"errorDescription":{"description":"Human-readable explanation of why the payout request failed.","type":"string"},"type":{"enum":["failed"],"type":"string"}},"required":["type","errorDescription"],"type":"object"},"PayoutRequestPendingStatusV2":{"properties":{"type":{"enum":["pending"],"type":"string"}},"required":["type"],"type":"object"},"PayoutRequestRecipientInfo":{"description":"Information about a recipient of a payout request","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The amount of the payout"},"createdAt":{"format":"date-time","type":"string"},"details":{"oneOf":[{"$ref":"#/components/schemas/FiatPayout","title":"Fiat Payout"},{"$ref":"#/components/schemas/BlockchainPayout","title":"Blockchain Payout"}]},"id":{"format":"uuid","type":"string"},"recipientInfo":{"description":"Information about how this payout recipient was specified - either via counterparty reference or inline details","oneOf":[{"$ref":"#/components/schemas/CounterpartyPayoutRecipientInfo","title":"Counterparty Payout Recipient Info"},{"$ref":"#/components/schemas/InlinePayoutRecipientInfo","title":"Inline Payout Recipient Info"}]},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","createdAt","updatedAt","amount","details","recipientInfo"],"type":"object"},"PayoutStatusFilter":{"description":"Filter based on the status of the Payout Request. A Payout that matches any of the provided statuses will be returned","properties":{"statuses":{"items":{"enum":["AWAITING_EXECUTION","CANCELED","PENDING","EXECUTED","FAILED"],"type":"string"},"type":"array"},"type":{"enum":["payoutStatus"],"type":"string"}},"required":["type","statuses"],"type":"object"},"PayoutSupportingDetails":{"properties":{"payoutPurpose":{"description":"The purpose of the payout. See \"Supporting Details Requirements\" in the Compliance Requirements section on the Guides page for information on when this is required.","enum":["VENDOR_PAYMENT","PAYROLL","TAX_PAYMENT","RENT_LEASE_PAYMENT","SUPPLIER_PAYMENT","PERSONAL_GIFT","FAMILY_SUPPORT","CHARITABLE_DONATION","EXPENSE_REIMBURSEMENT","BILL_UTILITY_PAYMENT","TRAVEL_EXPENSES","INVESTMENT_CONTRIBUTION","CASH_WITHDRAWAL","REAL_ESTATE_PURCHASE","OTHER"],"type":"string"},"supportingDocument":{"description":"**Supporting Document**\n\nA base64 encoded file showing the purpose for the payout.\n\n- **Format**: Base64 encoded data URI. File size must be less than 10MB.\n- **Examples**: Invoice, receipt, contract, etc.\n- **Note**: See \"Supporting Details Requirements\" in the Compliance Requirements section on the Guides page for information on when this is required.","example":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAA...","type":"string"}},"type":"object"},"PenDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["PEN"],"type":"string"},"type":{"enum":["pen"],"type":"string"}},"required":["type","symbol","documentNumber","documentType","bankAccountNumber","accountType"],"type":"object"},"PermanentResidenceCardGovernmentId":{"description":"Permanent residence card - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Permanent Residence Card Issuer (ISO 3166-1 alpha-2)","example":"US","title":"Country Code","type":"string"},"permanentResidenceCardBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of permanent residence card document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"residence_card_back.pdf"},"title":"Permanent Residence Card Back Document"},"permanentResidenceCardFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of permanent residence card document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"residence_card_front.pdf"},"title":"Permanent Residence Card Front Document"},"permanentResidenceCardNumber":{"description":"Permanent Residence Card Number","example":"R12345678","title":"Permanent Residence Card Number","type":"string"},"type":{"enum":["permanentResidenceCard"],"type":"string"}},"required":["type","permanentResidenceCardNumber","countryCode","permanentResidenceCardFrontDocument","permanentResidenceCardBackDocument"],"type":"object"},"PermanentResidenceCardIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"US","type":"string"},"permanentResidenceCardBackDocumentId":{"description":"File ID (UUID) of the back of the permanent residence card, from the document upload endpoint.","format":"uuid","type":"string"},"permanentResidenceCardFrontDocumentId":{"description":"File ID (UUID) of the front of the permanent residence card, from the document upload endpoint.","format":"uuid","type":"string"},"permanentResidenceCardNumber":{"description":"Permanent residence card number","example":"123-456-789","type":"string"},"type":{"enum":["permanentResidenceCard"],"type":"string"}},"required":["type","countryCode","permanentResidenceCardNumber","permanentResidenceCardFrontDocumentId","permanentResidenceCardBackDocumentId"],"title":"Permanent Residence Card","type":"object"},"PhysicalAddressInput":{"properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code. See: GET /utilities/countries/{fiatRailCode}","type":"string"},"state":{"description":"State or province. ISO 3166-2 subdivision code (minus the country prefix) for the state. See: GET /utilities/countries/{fiatRailCode}","type":"string"},"zip":{"type":"string"}},"required":["address1","country","state","city","zip"],"type":"object"},"PhysicalAddressVerification":{"properties":{"address1":{"description":"Primary street address, including building number and street name","example":"123 Main Street","title":"Address Line 1","type":"string"},"address2":{"description":"Secondary address line (apartment, suite, unit, floor, etc.)","example":"Suite 400","title":"Address Line 2","type":"string"},"city":{"description":"City or locality","example":"New York","title":"City","type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code","example":"US","title":"Country","type":"string"},"postalCode":{"description":"Postal code for the address","example":"10001","title":"Postal Code","type":"string"},"subDivision":{"description":"State or province. ISO 3166-2 subdivision code (minus the country prefix) for the state","example":"NY","title":"Subdivision","type":"string"}},"required":["address1","country","subDivision","city","postalCode"],"type":"object"},"PixPayinAmount":{"properties":{"currencySymbol":{"enum":["BRL"],"type":"string"},"value":{"description":"The amount in cents (e.g., \"2500\" represents 25.00).","example":"2500","type":"string"}},"required":["value","currencySymbol"],"type":"object"},"PixPayinRail":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/PixPayinAmount"}],"description":"The amount to simulate. Must be denominated in BRL."},"type":{"enum":["pix"],"type":"string"}},"required":["type","amount"],"type":"object"},"PostalIdGovernmentId":{"description":"Postal ID (Philippines) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Postal ID Issuer (ISO 3166-1 alpha-2) - Philippines only","enum":["PH"],"example":"PH","title":"Country Code","type":"string"},"postalIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of Postal ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"postal_id_back.pdf"},"title":"Postal ID Back Document"},"postalIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of Postal ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"postal_id_front.pdf"},"title":"Postal ID Front Document"},"postalIdNumber":{"description":"Postal ID Number","example":"PID12345678","title":"Postal ID Number","type":"string"},"type":{"enum":["postalId"],"type":"string"}},"required":["type","postalIdNumber","countryCode","postalIdFrontDocument","postalIdBackDocument"],"type":"object"},"PostalIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"PH","type":"string"},"postalIdBackDocumentId":{"description":"File ID (UUID) of the back of the postal ID, from the document upload endpoint.","format":"uuid","type":"string"},"postalIdFrontDocumentId":{"description":"File ID (UUID) of the front of the postal ID, from the document upload endpoint.","format":"uuid","type":"string"},"postalIdNumber":{"description":"Postal ID number","example":"P1234567890","type":"string"},"type":{"enum":["postalId"],"type":"string"}},"required":["type","countryCode","postalIdNumber","postalIdFrontDocumentId","postalIdBackDocumentId"],"title":"Postal ID","type":"object"},"ProofOfAddressDocumentReference":{"properties":{"documentType":{"description":"The type of proof-of-address document","enum":["BANK_STATEMENT","GOVERNMENT_ISSUED_LETTER","UTILITY_BILL"],"example":"UTILITY_BILL","type":"string","x-order":1},"documentId":{"description":"File ID (UUID) returned by the compliance document upload endpoint.","format":"uuid","type":"string","x-order":2}},"required":["documentType","documentId"],"type":"object"},"ProofOfAddressDocumentUpload":{"properties":{"documentContent":{"description":"**Supporting Document**\n\nA base64 encoded file showing the purpose for the payout.\n\n- **Format**: Base64 encoded data URI. File size must be less than 10MB.\n- **Supported formats**: PDF, JPEG, JPG, PNG, CSV\n- **Note**: See Supporting Details Requirements for information on when this is required.","title":"Document Content","type":"string"},"documentType":{"description":"Document type","enum":["BANK_STATEMENT","GOVERNMENT_ISSUED_LETTER","UTILITY_BILL"],"example":"GOVERNMENT_ISSUED_LETTER","title":"Document Type","type":"string"},"filename":{"description":"Document filename with extension","title":"Document Filename","type":"string"}},"required":["filename","documentType","documentContent"],"type":"object"},"RecipientValidationFailure":{"properties":{"details":{"description":"Details of which recipient information is missing. The shape depends on whether the payout referenced an inline recipient or a saved counterparty.","oneOf":[{"$ref":"#/components/schemas/MissingInlineRecipientInformation","title":"Inline recipient"},{"$ref":"#/components/schemas/MissingCounterpartyInformation","title":"Counterparty"}]},"payoutIndex":{"description":"Zero-based index of the failing payout within the request body's `payouts` array.","type":"number"}},"required":["payoutIndex","details"],"type":"object"},"RefundedPayoutMetadata":{"description":"Refund transaction for a previously failed payout","properties":{"payoutId":{"description":"The payout ID of the original payout that was refunded","format":"uuid","type":"string"},"payoutRequestId":{"description":"The payout request ID of the original payout that was refunded","format":"uuid","type":"string"},"type":{"enum":["refundedPayout"],"type":"string"}},"required":["type","payoutRequestId","payoutId"],"type":"object"},"Rejected":{"description":"Indicates the currency was rejected during the KYC process","properties":{"details":{"type":"string"},"reason":{"enum":["KYC_FAILED"],"type":"string"},"type":{"enum":["rejected"],"type":"string"}},"required":["type","reason","details"],"type":"object"},"RejectedComplianceAttestation":{"properties":{"attestationType":{"description":"Attestation type with validation failures.","enum":["individualPersonalInfoLight","individualPersonalInfo","individualContactInfo","individualResidentialAddress","individualIdentityDocument","individualFinancialInfo","individualTaxInfo","individualEeaInfo","individualProofOfAddress","individualSourceOfFunds","individualSelfiePhoto","businessIdentification","businessTaxInfo","businessAddress","businessContactInfo","businessDetails","businessOperations","businessFinancialInfo","businessFormationDocuments","businessUboOwnershipDocuments","businessProofOfAddressDocuments","businessFlowOfFundsDocument","businessAssociatedPersons"],"type":"string"},"failures":{"description":"Information about the failed validations for this attestation","items":{"$ref":"#/components/schemas/AttestationValidationFailure"},"type":"array"},"id":{"description":"Attestation UUID","format":"uuid","type":"string"}},"required":["id","attestationType","failures"],"type":"object"},"ResidencePermitGovernmentId":{"description":"Residence permit - requires front document, back document required for most countries","properties":{"countryCode":{"description":"Country Code of Residence Permit Issuer (ISO 3166-1 alpha-2)","example":"DE","title":"Country Code","type":"string"},"residencePermitBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of residence permit document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"residence_permit_back.pdf"},"title":"Residence Permit Back Document"},"residencePermitFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of residence permit document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"residence_permit_front.pdf"},"title":"Residence Permit Front Document"},"residencePermitNumber":{"description":"Residence Permit Number","example":"RP12345678","title":"Residence Permit Number","type":"string"},"type":{"enum":["residencePermit"],"type":"string"}},"required":["type","residencePermitNumber","countryCode","residencePermitFrontDocument","residencePermitBackDocument"],"type":"object"},"ResidencePermitIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"DE","type":"string"},"residencePermitBackDocumentId":{"description":"File ID (UUID) of the back of the residence permit, from the document upload endpoint.","format":"uuid","type":"string"},"residencePermitFrontDocumentId":{"description":"File ID (UUID) of the front of the residence permit, from the document upload endpoint.","format":"uuid","type":"string"},"residencePermitNumber":{"description":"Residence permit number","example":"RP1234567","type":"string"},"type":{"enum":["residencePermit"],"type":"string"}},"required":["type","countryCode","residencePermitNumber","residencePermitFrontDocumentId","residencePermitBackDocumentId"],"title":"Residence Permit","type":"object"},"Restricted":{"description":"Indicates the currency is disabled for use with your Mural account. This is most likely due to a restricted geography","properties":{"details":{"type":"string"},"reason":{"enum":["CAPABILITY_UNAVAILABLE","PROCESSING_ERROR"],"type":"string"},"type":{"enum":["disabled"],"type":"string"}},"required":["type","reason","details"],"type":"object"},"SearchCounterpartiesRequestInfo":{"properties":{"filter":{"description":"Filter for counterparties. An empty filter returns all counterparties.","oneOf":[{"$ref":"#/components/schemas/CounterpartyEmailFilter","title":"Email"}]}},"type":"object"},"SearchPayoutMethodsRequestInfo":{"properties":{"filter":{"description":"Filter for payout methods. An empty filter returns all payout methods.","oneOf":[{"$ref":"#/components/schemas/PayoutMethodAliasFilter","title":"Alias"}]}},"type":"object"},"SelfiePhotoDocumentUpload":{"properties":{"documentContent":{"description":"**Selfie Photo Document**\n\nA base64 encoded image of the individual for identity verification.\n\n- **Format**: Base64 encoded data URI. File size must be less than 10MB.\n- **Supported formats**: JPEG, JPG, PNG\n- **Note**: Please upload a clear photo of your face. Ensure good lighting and that your face is clearly visible.","title":"Selfie Photo Content","type":"string"},"filename":{"description":"Document filename with extension","title":"Document Filename","type":"string"}},"required":["filename","documentContent"],"type":"object"},"SendTestWebhookEventByCategory":{"properties":{"category":{"description":"Webhook category to generate a test event for","enum":["MURAL_ACCOUNT_BALANCE_ACTIVITY","BUSINESS_VERIFICATION_STATUS","ORGANIZATION_TOS","PAYOUT_REQUEST","PAYIN","COMPLIANCE_REVIEW"],"type":"string"},"type":{"description":"The type discriminator for this event","enum":["categoryTest"],"type":"string"}},"required":["type","category"],"type":"object"},"SendWebhookEventRequest":{"properties":{"event":{"description":"Send event request","oneOf":[{"$ref":"#/components/schemas/SendTestWebhookEventByCategory","title":"Test Event for Category"}]}},"required":["event"],"type":"object"},"SetDeveloperFeesRequest":{"properties":{"payinsDeveloperFees":{"description":"Array of developer fees configuration for payins by currency. This will correspond to the payinMethods associated with the account","example":[{"developerFeePercentage":2.5,"type":"usd"},{"developerFeePercentage":1.8,"type":"eur"},{"developerFeePercentage":2,"type":"mxn"},{"developerFeePercentage":1.5,"type":"brl"},{"developerFeePercentage":2,"type":"ars"}],"items":{"oneOf":[{"$ref":"#/components/schemas/USDDeveloperFee"},{"$ref":"#/components/schemas/EURDeveloperFee"},{"$ref":"#/components/schemas/MXNDeveloperFee"},{"$ref":"#/components/schemas/BRLDeveloperFee"},{"$ref":"#/components/schemas/ARSDeveloperFee"}]},"type":"array"}},"required":["payinsDeveloperFees"],"type":"object"},"SetSettlementStrategyRequest":{"properties":{"payinsSettlementStrategies":{"description":"Array of settlement strategy configurations by currency.","example":[{"settlementStrategy":{"type":"holdInFiat"},"type":"usd"}],"items":{"oneOf":[{"$ref":"#/components/schemas/USDSettlementStrategyConfig","title":"USD"}]},"type":"array"}},"required":["payinsSettlementStrategies"],"type":"object"},"SignatoryAuthorityDocumentReference":{"properties":{"documentType":{"description":"The type of signatory-authority document","enum":["LETTER_OF_AUTHORITY","BOARD_RESOLUTION","POWER_OF_ATTORNEY"],"example":"LETTER_OF_AUTHORITY","type":"string","x-order":1},"documentId":{"description":"File ID (UUID) returned by the compliance document upload endpoint.","format":"uuid","type":"string","x-order":2}},"required":["documentType","documentId"],"type":"object"},"SignedAgreementRequiredErrorBodyParams":{"properties":{"organizationId":{"description":"Organization ID that must accept the agreement","format":"uuid","type":"string"}},"required":["organizationId"],"type":"object"},"SignedAgreementRequiredExceptionBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"SignedAgreementRequiredException","type":"string"},"params":{"$ref":"#/components/schemas/SignedAgreementRequiredErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"SimpleFiatAmount":{"properties":{"fiatAmount":{"description":"The fiat amount.","type":"number"},"fiatCurrencyCode":{"description":"The fiat currency code.","enum":["USD","COP","ARS","EUR","MXN","BRL","CLP","PEN","BOB","CRC","ZAR"],"example":"USD","type":"string"}},"required":["fiatAmount","fiatCurrencyCode"],"type":"object"},"SimulateComplianceReviewTransitionRequest":{"properties":{"transition":{"description":"The target state to drive the compliance review to.","discriminator":{"mapping":{"approved":"#/components/schemas/SimulateTransitionToApproved","error":"#/components/schemas/SimulateTransitionToError","inReview":"#/components/schemas/SimulateTransitionToInReview","rejected":"#/components/schemas/SimulateTransitionToRejected"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/SimulateTransitionToInReview","title":"In Review"},{"$ref":"#/components/schemas/SimulateTransitionToApproved","title":"Approved"},{"$ref":"#/components/schemas/SimulateTransitionToRejected","title":"Rejected"},{"$ref":"#/components/schemas/SimulateTransitionToError","title":"Error"}]}},"required":["transition"],"type":"object"},"SimulateSandboxPayinRequest":{"properties":{"destinationAccountId":{"description":"The ID of the payin deposit account that will receive the simulated inbound transfer.","example":"b4f3c1d2-89ab-4e56-8f01-23456789abcd","format":"uuid","type":"string"},"rail":{"description":"The payment rail and amount for the simulated payin. Use the `type` discriminator to select the rail; each rail enforces a fixed currency (SPEI → MXN, PIX → BRL, CVU → ARS, ACH/WIRE → USD).","oneOf":[{"$ref":"#/components/schemas/SpeiPayinRail","title":"SPEI"},{"$ref":"#/components/schemas/PixPayinRail","title":"PIX"},{"$ref":"#/components/schemas/CvuPayinRail","title":"CVU"},{"$ref":"#/components/schemas/AchPayinRail","title":"ACH"},{"$ref":"#/components/schemas/WirePayinRail","title":"WIRE"}]}},"required":["destinationAccountId","rail"],"type":"object"},"SimulateTransitionToApproved":{"description":"Approves an in-review compliance review.","properties":{"type":{"enum":["approved"],"type":"string"}},"required":["type"],"type":"object"},"SimulateTransitionToError":{"description":"Marks an in-review compliance review as errored.","properties":{"errorDescription":{"description":"Diagnostic detail recorded on the errored review.","type":"string"},"type":{"enum":["error"],"type":"string"}},"required":["type","errorDescription"],"type":"object"},"SimulateTransitionToInReview":{"description":"Moves a submitted review under compliance review.","properties":{"type":{"enum":["inReview"],"type":"string"}},"required":["type"],"type":"object"},"SimulateTransitionToRejected":{"description":"Rejects an in-review compliance review with a reason.","properties":{"rejectionDescription":{"description":"Reason surfaced on the rejected review.","type":"string"},"type":{"enum":["rejected"],"type":"string"}},"required":["type","rejectionDescription"],"type":"object"},"SourceAmount":{"description":"A source-denominated payout amount: the caller specifies the source amount to debit, and Mural derives what the recipient receives.","properties":{"sourceCurrency":{"description":"The source to debit for this payout: either a fiat currency (`fiat`) or a stablecoin (`stablecoin`, identified by token symbol and blockchain).","discriminator":{"mapping":{"fiat":"#/components/schemas/FiatSourceCurrency","stablecoin":"#/components/schemas/StablecoinSourceCurrency"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/FiatSourceCurrency","title":"Fiat"},{"$ref":"#/components/schemas/StablecoinSourceCurrency","title":"Stablecoin"}]},"type":{"enum":["sourceAmount"],"type":"string"},"value":{"description":"The source amount to debit, in the minor unit (hundredths) of the source currency, as a string to preserve precision (e.g. \"10050\" = 100.50).","example":"10050","type":"string"}},"required":["type","sourceCurrency","value"],"type":"object"},"SourceOfFundsDocumentReference":{"properties":{"documentType":{"description":"The type of source-of-funds document","enum":["CRYPTO_DIGITAL_ASSETS","EMPLOYMENT_INCOME","INHERITANCE_GIFT","INVESTMENTS_DIVIDENDS","LOANS_CREDIT_FACILITIES","OTHER_VERIFIED_SOURCES","PENSION_SOCIAL_BENEFITS","SALE_OF_ASSETS","SAVINGS_ACCUMULATED_FUNDS","SELF_EMPLOYMENT_BUSINESS_INCOME"],"example":"EMPLOYMENT_INCOME","type":"string","x-order":1},"documentId":{"description":"File ID (UUID) returned by the compliance document upload endpoint.","format":"uuid","type":"string","x-order":2}},"required":["documentType","documentId"],"type":"object"},"SourceOfFundsDocumentUpload":{"properties":{"documentContent":{"description":"**Supporting Document**\n\nA base64 encoded file showing the purpose for the payout.\n\n- **Format**: Base64 encoded data URI. File size must be less than 10MB.\n- **Supported formats**: PDF, JPEG, JPG, PNG, CSV\n- **Note**: See Supporting Details Requirements for information on when this is required.","title":"Document Content","type":"string"},"documentType":{"description":"Document type","enum":["CRYPTO_DIGITAL_ASSETS","EMPLOYMENT_INCOME","INHERITANCE_GIFT","INVESTMENTS_DIVIDENDS","LOANS_CREDIT_FACILITIES","OTHER_VERIFIED_SOURCES","PENSION_SOCIAL_BENEFITS","SALE_OF_ASSETS","SAVINGS_ACCUMULATED_FUNDS","SELF_EMPLOYMENT_BUSINESS_INCOME"],"example":"EMPLOYMENT_INCOME","title":"Document Type","type":"string"},"filename":{"description":"Document filename with extension","title":"Document Filename","type":"string"}},"required":["filename","documentType","documentContent"],"type":"object"},"SpeiPayinAmount":{"properties":{"currencySymbol":{"enum":["MXN"],"type":"string"},"value":{"description":"The amount in cents (e.g., \"2500\" represents 25.00).","example":"2500","type":"string"}},"required":["value","currencySymbol"],"type":"object"},"SpeiPayinRail":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/SpeiPayinAmount"}],"description":"The amount to simulate. Must be denominated in MXN."},"type":{"enum":["spei"],"type":"string"}},"required":["type","amount"],"type":"object"},"SssIdGovernmentId":{"description":"SSS ID (Philippines) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of SSS ID Issuer (ISO 3166-1 alpha-2) - Philippines only","enum":["PH"],"example":"PH","title":"Country Code","type":"string"},"sssIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of SSS ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"sss_id_back.pdf"},"title":"SSS ID Back Document"},"sssIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of SSS ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"sss_id_front.pdf"},"title":"SSS ID Front Document"},"sssIdNumber":{"description":"SSS ID Number","example":"SSS12345678","title":"SSS ID Number","type":"string"},"type":{"enum":["sssId"],"type":"string"}},"required":["type","sssIdNumber","countryCode","sssIdFrontDocument","sssIdBackDocument"],"type":"object"},"SssIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"PH","type":"string"},"sssIdBackDocumentId":{"description":"File ID (UUID) of the back of the SSS ID, from the document upload endpoint.","format":"uuid","type":"string"},"sssIdFrontDocumentId":{"description":"File ID (UUID) of the front of the SSS ID, from the document upload endpoint.","format":"uuid","type":"string"},"sssIdNumber":{"description":"SSS ID number","example":"01-2345678-9","type":"string"},"type":{"enum":["sssId"],"type":"string"}},"required":["type","countryCode","sssIdNumber","sssIdFrontDocumentId","sssIdBackDocumentId"],"title":"SSS ID","type":"object"},"StablecoinSourceCurrency":{"description":"A stablecoin source currency to debit, identified by its token symbol and the blockchain it lives on.","properties":{"token":{"allOf":[{"$ref":"#/components/schemas/TokenWithBlockchain"}],"description":"The stablecoin token and the blockchain it lives on."},"type":{"enum":["stablecoin"],"type":"string"}},"required":["type","token"],"type":"object"},"StateIdGovernmentId":{"description":"State ID - requires front and back documents","properties":{"countryCode":{"description":"Country Code of State ID Issuer (ISO 3166-1 alpha-2)","example":"US","title":"Country Code","type":"string"},"stateIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of state ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"state_id_back.pdf"},"title":"State ID Back Document"},"stateIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of state ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"state_id_front.pdf"},"title":"State ID Front Document"},"stateIdNumber":{"description":"State ID Number","example":"S12345678","title":"State ID Number","type":"string"},"type":{"enum":["stateId"],"type":"string"}},"required":["type","stateIdNumber","countryCode","stateIdFrontDocument","stateIdBackDocument"],"type":"object"},"StateIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"US","type":"string"},"stateIdBackDocumentId":{"description":"File ID (UUID) of the back of the state ID, from the document upload endpoint.","format":"uuid","type":"string"},"stateIdFrontDocumentId":{"description":"File ID (UUID) of the front of the state ID, from the document upload endpoint.","format":"uuid","type":"string"},"stateIdNumber":{"description":"State ID number","example":"D1234567","type":"string"},"type":{"enum":["stateId"],"type":"string"}},"required":["type","countryCode","stateIdNumber","stateIdFrontDocumentId","stateIdBackDocumentId"],"title":"State ID","type":"object"},"SubmitBusinessComplianceReviewResponse":{"properties":{"id":{"description":"Unique review ID","format":"uuid","type":"string","x-order":1},"tier":{"description":"The tier this review is for.","enum":["US_STANDARD","FULL"],"example":"FULL","type":"string","x-order":2},"type":{"enum":["business"],"type":"string","x-order":3},"status":{"description":"Current status of the compliance review.","oneOf":[{"$ref":"#/components/schemas/ComplianceReviewStatusValidatingSubmission","title":"Validating Submission"},{"$ref":"#/components/schemas/ComplianceReviewStatusSubmissionValidationsFailed","title":"Submission Validations Failed"},{"$ref":"#/components/schemas/ComplianceReviewStatusSubmitted","title":"Submitted"}],"x-order":4}},"required":["id","tier","type","status"],"type":"object"},"SubmitComplianceReviewRequest":{"properties":{"acknowledgeWarnings":{"default":false,"description":"Set to `true` to acknowledge any attestation or compliance review warnings and proceed with submission.","type":"boolean"}},"type":"object"},"SubmitIndividualComplianceReviewResponse":{"properties":{"id":{"description":"Unique review ID","format":"uuid","type":"string","x-order":1},"tier":{"description":"The tier this review is for.","enum":["LIGHT","STANDARD"],"example":"LIGHT","type":"string","x-order":2},"type":{"enum":["individual"],"type":"string","x-order":3},"status":{"description":"Current status of the compliance review.","oneOf":[{"$ref":"#/components/schemas/ComplianceReviewStatusValidatingSubmission","title":"Validating Submission"},{"$ref":"#/components/schemas/ComplianceReviewStatusSubmissionValidationsFailed","title":"Submission Validations Failed"},{"$ref":"#/components/schemas/ComplianceReviewStatusSubmitted","title":"Submitted"}],"x-order":4}},"required":["id","tier","type","status"],"type":"object"},"TOSRelianceInfo":{"properties":{"signedAgreementId":{"description":"Unique identifier for the signed agreement in your system","maxLength":36,"type":"string"},"signedAt":{"description":"Date when the agreement was signed (ISO 8601 format)","type":"string"}},"required":["signedAgreementId","signedAt"],"type":"object"},"TargetAmount":{"description":"A destination-denominated payout amount: the caller specifies the exact fiat amount the recipient should receive, and Mural derives the source debit. Only supported for fiat payouts.","properties":{"sourceCurrency":{"description":"The source to debit for this payout: either a fiat currency (`fiat`) or a stablecoin (`stablecoin`, identified by token symbol and blockchain).","discriminator":{"mapping":{"fiat":"#/components/schemas/FiatSourceCurrency","stablecoin":"#/components/schemas/StablecoinSourceCurrency"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/FiatSourceCurrency","title":"Fiat"},{"$ref":"#/components/schemas/StablecoinSourceCurrency","title":"Stablecoin"}]},"type":{"enum":["targetAmount"],"type":"string"},"value":{"description":"The exact fiat amount the recipient should receive, in the minor unit (cents) of the currency as a string to preserve precision (e.g. \"15000\" = 150.00). The currency is derived from the payout destination.","example":"15000","type":"string"}},"required":["type","value","sourceCurrency"],"type":"object"},"TaxIdentificationNumber":{"properties":{"taxIdentificationNumber":{"example":"123456789","title":"Tax Identification Number","type":"string"},"taxIdentificationNumberType":{"description":"The type of tax identification number","enum":["ABN","ACN","AOM","ADOAZ","ADOSZAM","AHV","ARBN","BCE","BIN","BIN_BD","BIN_KZ","BIR","BN","BP","BRN","BSN","BVN","CDI","CEDULA_JURIDICA","CF","CIN","CN","CNP","CNPJ","CPR","CPF","CR","CRIB","CRN","CRO","CUI","CUIL","CUIT","CURP","CVR","EDB","EDRPOU","EGN","EIN","EMIRATES_ID","EMSO","EN","FIN","FN","FODSELSNR","GST","GSTIN","HETU","HKID","HN","IC","ICE","ID","ID_BROJ","IDNO","IDNP","IDU","IF","ICO","IIN","IK","IMONES_KODAS","INE","INN","IRD","ITIN","ITR","JMBG","KBO","KVK","MATICNA","MATRICULE","MN","MST","NIF","NINEA","NIN","NINO","NIP","NIPT","NIT","NPWP","NRIC","NRN","NRT","NTN","OGRN","OIB","ORGNR","PAN","PARTITA_IVA","PERSONNUMMER","PESEL","PIN","PINFL","PIB","PPSN","RC","RCCM","REGISTRIKOOD","RFC","RICN","RIF","RN","RNC","RNOKPP","RODNE_CISLO","RP","RRN","RTN","RUC","RUT","SI","SIN","SIREN","SIRET","SPI","SSM","SSN","STEUER_ID","TCKN","TFN","TIN","TRN","UCN","UEN","UIC","UID","UNP","USC","UST_IDNR","UTR","VAT","VKN","VOEN","Y_TUNNUS"],"example":"EIN","title":"Tax Identification Number Type","type":"string"}},"required":["taxIdentificationNumber","taxIdentificationNumberType"],"type":"object"},"TermsOfService":{"description":"Indicates a Term of Service acceptance is required as part of the verification process required to use this currency","properties":{"details":{"type":"string"},"type":{"enum":["termsOfService"],"type":"string"}},"required":["type","details"],"type":"object"},"ThirdPartyUser":{"properties":{"authMethods":{"description":"The authentication methods of the user","items":{"enum":["EMAIL"],"type":"string"},"type":"array"},"createdAt":{"format":"date-time","type":"string"},"email":{"description":"Email address of the user","type":"string"},"id":{"format":"uuid","type":"string"},"name":{"description":"The name of the user","type":"string"}},"required":["id","createdAt","name","email","authMethods"],"type":"object"},"TokenAmount":{"properties":{"tokenAmount":{"description":"The token amount.","type":"number"},"tokenSymbol":{"description":"The token symbol.","example":"USDC","type":"string"}},"required":["tokenAmount","tokenSymbol"],"type":"object"},"TokenPayoutFeeError":{"properties":{"fiatAndRailCode":{"description":"The currency and if applicable, rail, that the token will be converted to.","enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"},"message":{"description":"The error message explaining why the fee calculation failed","type":"string"},"reason":{"allOf":[{"$ref":"#/components/schemas/PayoutFeeErrorReason"}],"description":"Why the fee could not be quoted. Only a temporarily unavailable payout is worth retrying."},"tokenAmount":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The token amount provided in the request."},"type":{"enum":["error"],"type":"string"}},"required":["type","tokenAmount","message","reason","fiatAndRailCode"],"type":"object"},"TokenPayoutFeeSuccess":{"properties":{"estimatedFiatAmount":{"allOf":[{"$ref":"#/components/schemas/SimpleFiatAmount"}],"description":"The estimated fiat amount you will receive based on the tokenAmount value provided."},"exchangeFeePercentage":{"description":"The total fee for the transaction (in percentile) applied at transaction execution time. This is applied to the source token amount.","type":"number"},"exchangeRate":{"description":"The exchange rate for the transaction. The rate at which the token amount will be converted to fiat. The units are destination fiat per token.","type":"number"},"feeTotal":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The total fee for the fiat payout."},"fiatAndRailCode":{"description":"The currency and if applicable, rail, that the token will be converted to.","enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"},"minTransactionValue":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The minimum value for the transaction, if applicable."},"tokenAmount":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The token amount you will need to send."},"transactionFee":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The expected, flat transaction fee applied to the payout"},"type":{"enum":["success"],"type":"string"}},"required":["exchangeRate","exchangeFeePercentage","fiatAndRailCode","transactionFee","type","estimatedFiatAmount","tokenAmount","feeTotal"],"type":"object"},"TokenWithBlockchain":{"properties":{"blockchain":{"description":"The blockchain of the token","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA"],"type":"string"},"symbol":{"description":"The symbol of the token","enum":["USDC","USDT"],"type":"string"}},"required":["symbol","blockchain"],"type":"object"},"Transaction":{"properties":{"accountId":{"description":"The account ID of the Transaction","type":"string"},"amount":{"allOf":[{"$ref":"#/components/schemas/TokenAmount"}],"description":"The amount of the Transaction"},"blockchain":{"description":"The blockchain type of the Transaction","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA"],"type":"string"},"counterpartyInfo":{"description":"The details of the Counterparty. This can be the sender or recipient, depending on the transactionDetails","oneOf":[{"$ref":"#/components/schemas/UnknownCounterparty","title":"Unknown"},{"$ref":"#/components/schemas/Counterparty","title":"Known"}]},"hash":{"description":"The hash of the Transaction","type":"string"},"id":{"description":"The unique identifier for the Transaction","type":"string"},"memo":{"description":"The memo of the Transaction","type":"string"},"transactionDetails":{"description":"The details of the Transaction","oneOf":[{"$ref":"#/components/schemas/PayoutMetadata","title":"Payout"},{"$ref":"#/components/schemas/DepositMetadata","title":"Deposit"},{"$ref":"#/components/schemas/ExternalPayoutMetadata","title":"External Payout"},{"$ref":"#/components/schemas/RefundedPayoutMetadata","title":"Refunded Payout"}]},"transactionExecutionDate":{"description":"The date of the Transaction","format":"date-time","type":"string"}},"required":["id","hash","transactionExecutionDate","blockchain","amount","accountId","counterpartyInfo","transactionDetails"],"type":"object"},"TransactionInProgressErrorBody":{"properties":{"errorInstanceId":{"description":"Unique error instance ID","format":"uuid","type":"string"},"message":{"type":"string"},"name":{"example":"TransactionInProgressError","type":"string"},"params":{"$ref":"#/components/schemas/TransactionInProgressErrorBodyParams"}},"required":["errorInstanceId","name","message","params"],"type":"object"},"TransactionInProgressErrorBodyParams":{"properties":{"safeAddress":{"description":"Address of the Safe with an in-progress transaction","type":"string"}},"required":["safeAddress"],"type":"object"},"TravelDocumentGovernmentId":{"description":"Travel Document - typically single-sided","properties":{"countryCode":{"description":"Country Code of Travel Document Issuer (ISO 3166-1 alpha-2)","example":"US","title":"Country Code","type":"string"},"travelDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Travel Document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"travel_document.pdf"},"title":"Travel Document"},"travelDocumentBack":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of Travel Document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"travel_document_back.pdf"},"title":"Travel Document Back"},"travelDocumentNumber":{"description":"Travel Document Number","example":"TD12345678","title":"Travel Document Number","type":"string"},"type":{"enum":["travelDocument"],"type":"string"}},"required":["type","travelDocumentNumber","countryCode","travelDocument"],"type":"object"},"TravelDocumentIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"DE","type":"string"},"travelDocumentDocumentId":{"description":"File ID (UUID) of the travel document, from the document upload endpoint.","format":"uuid","type":"string"},"travelDocumentNumber":{"description":"Travel document number","example":"C01X00T47","type":"string"},"type":{"enum":["travelDocument"],"type":"string"}},"required":["type","countryCode","travelDocumentNumber","travelDocumentDocumentId"],"title":"Travel Document","type":"object"},"TribalIdGovernmentId":{"description":"Tribal ID (Canada) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Tribal ID Issuer (ISO 3166-1 alpha-2) - Canada only","enum":["CA"],"example":"CA","title":"Country Code","type":"string"},"tribalIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of Tribal ID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"tribal_id_back.pdf"},"title":"Tribal ID Back Document"},"tribalIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of Tribal ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"tribal_id_front.pdf"},"title":"Tribal ID Front Document"},"tribalIdNumber":{"description":"Tribal ID Number","example":"TID12345678","title":"Tribal ID Number","type":"string"},"type":{"enum":["tribalId"],"type":"string"}},"required":["type","tribalIdNumber","countryCode","tribalIdFrontDocument","tribalIdBackDocument"],"type":"object"},"TribalIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"US","type":"string"},"tribalIdBackDocumentId":{"description":"File ID (UUID) of the back of the tribal ID, from the document upload endpoint.","format":"uuid","type":"string"},"tribalIdFrontDocumentId":{"description":"File ID (UUID) of the front of the tribal ID, from the document upload endpoint.","format":"uuid","type":"string"},"tribalIdNumber":{"description":"Tribal ID enrollment number","example":"T1234567","type":"string"},"type":{"enum":["tribalId"],"type":"string"}},"required":["type","countryCode","tribalIdNumber","tribalIdFrontDocumentId","tribalIdBackDocumentId"],"title":"Tribal ID","type":"object"},"UBOVerificationResponse":{"properties":{"createdAt":{"description":"Creation Timestamp","example":"2023-01-01T00:00:00Z","format":"date-time","title":"Created At","type":"string"},"uboDocuments":{"description":"List of Documents Associated with this Verification","items":{"$ref":"#/components/schemas/DocumentResponse"},"title":"Documents","type":"array"},"uboFirstName":{"description":"UBO First Name","example":"John","title":"UBO First Name","type":"string"},"uboLastName":{"description":"UBO Last Name","example":"Doe","title":"UBO Last Name","type":"string"},"updatedAt":{"description":"Last Update Timestamp","example":"2023-01-01T00:00:00Z","format":"date-time","title":"Updated At","type":"string"},"verificationId":{"description":"Unique Verification Identifier","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid","title":"Verification ID","type":"string"},"verificationStatus":{"description":"Verification Status","example":{"type":"pending"},"oneOf":[{"$ref":"#/components/schemas/VerificationStatusInactive"},{"$ref":"#/components/schemas/VerificationStatusPending"},{"$ref":"#/components/schemas/VerificationStatusApproved"},{"$ref":"#/components/schemas/VerificationStatusError"},{"$ref":"#/components/schemas/VerificationStatusRejected"}],"title":"Verification Status"}},"required":["verificationId","uboFirstName","uboLastName","verificationStatus","uboDocuments","createdAt","updatedAt"],"type":"object"},"USDCSOLANADepositToken":{"properties":{"blockchain":{"description":"The blockchain of the token","enum":["SOLANA"],"type":"string"},"contractAddress":{"description":"The Solana address of the token","type":"string"},"symbol":{"description":"The symbol of the token","enum":["USDC"],"type":"string"},"type":{"enum":["usdc_solana"],"type":"string"}},"required":["contractAddress","type","symbol","blockchain"],"type":"object"},"USDChinaPayoutMethodDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_usd_china_001","type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["PASSPORT","TAX_ID","RESIDENT_ID"],"type":"string"},"phoneNumber":{"format":"phone","type":"string"},"swiftBic":{"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usdChina"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","documentNumber","documentType","phoneNumber","swiftBic","bankId"],"type":"object"},"USDChinaPayoutMethodResponseDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****7654","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_usd_china_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****3456","type":"string"},"documentType":{"enum":["PASSPORT","TAX_ID","RESIDENT_ID"],"type":"string"},"phoneNumberTruncated":{"description":"Masked phone number (format: ****1234)","example":"****0000","type":"string"},"swiftBicTruncated":{"description":"Masked SWIFT/BIC code (format: ****1234)","example":"****US33","type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usdChina"],"type":"string"}},"required":["type","symbol","accountType","documentType","bankId","bankAccountNumberTruncated","documentNumberTruncated","swiftBicTruncated","phoneNumberTruncated"],"type":"object"},"USDDeveloperFee":{"properties":{"developerFeePercentage":{"description":"Developer fee percentage for USD payins (0-100)","example":2.5,"maximum":100,"minimum":0,"type":"number"},"type":{"enum":["usd"],"type":"string"}},"required":["type","developerFeePercentage"],"type":"object"},"USDDomesticPayoutMethodDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankName":{"type":"string"},"bankRoutingNumber":{"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"transferType":{"description":"Transfer type (ACH or WIRE)","enum":["ACH","WIRE"],"type":"string"},"type":{"enum":["usdDomestic"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","bankRoutingNumber","transferType","bankName"],"type":"object"},"USDDomesticPayoutMethodResponseDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****1234","type":"string"},"bankName":{"type":"string"},"bankRoutingNumberTruncated":{"description":"Masked bank routing number (format: ****1234)","example":"****0021","type":"string"},"symbol":{"enum":["USD"],"type":"string"},"transferType":{"description":"Transfer type (ACH or WIRE)","enum":["ACH","WIRE"],"type":"string"},"type":{"enum":["usdDomestic"],"type":"string"}},"required":["type","symbol","accountType","transferType","bankName","bankAccountNumberTruncated","bankRoutingNumberTruncated"],"type":"object"},"USDHongKongPayoutMethodDetails":{"properties":{"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_usd_hong_kong_001","type":"string"},"swiftBic":{"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usdHongKong"],"type":"string"}},"required":["type","symbol","bankAccountNumber","swiftBic","bankId"],"type":"object"},"USDHongKongPayoutMethodResponseDetails":{"properties":{"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****9456","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_usd_hong_kong_001","type":"string"},"swiftBicTruncated":{"description":"Masked SWIFT/BIC code (format: ****ABCD)","example":"****HKHK","type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usdHongKong"],"type":"string"}},"required":["type","symbol","bankId","bankAccountNumberTruncated","swiftBicTruncated"],"type":"object"},"USDPanamaPayoutMethodDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_usd_panama_001","type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","RUC_NIT","PASSPORT","RESIDENT_ID"],"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usdPanama"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","documentNumber","documentType","bankId"],"type":"object"},"USDPanamaPayoutMethodResponseDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****9456","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_usd_panama_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****8888","type":"string"},"documentType":{"enum":["NATIONAL_ID","RUC_NIT","PASSPORT","RESIDENT_ID"],"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usdPanama"],"type":"string"}},"required":["type","symbol","accountType","documentType","bankId","bankAccountNumberTruncated","documentNumberTruncated"],"type":"object"},"USDPayinRailDetails":{"properties":{"bankAccountNumber":{"type":"string"},"bankAccountType":{"description":"The type of bank account (checking or savings).","enum":["CHECKING","SAVINGS"],"type":"string"},"bankAddress":{"type":"string"},"bankBeneficiaryAddress":{"type":"string"},"bankBeneficiaryName":{"type":"string"},"bankName":{"type":"string"},"bankRoutingNumber":{"type":"string"},"currency":{"enum":["USD"],"type":"string"},"payinRails":{"items":{"enum":["ACH","WIRE"],"type":"string"},"type":"array"},"settlementStrategy":{"description":"The settlement strategy for this payin method. Controls whether incoming funds are held as fiat or automatically on-ramped to the Account destination token.","oneOf":[{"$ref":"#/components/schemas/HoldInFiatSettlementStrategy","title":"Hold In Fiat"},{"$ref":"#/components/schemas/AutoOnrampSettlementStrategy","title":"Auto Onramp"}]},"type":{"enum":["usd"],"type":"string"}},"required":["type","currency","payinRails","bankBeneficiaryName","bankBeneficiaryAddress","bankName","bankAddress","bankRoutingNumber","bankAccountNumber","bankAccountType","settlementStrategy"],"type":"object"},"USDPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/USDDomesticPayoutMethodDetails","title":"USD Domestic"},{"$ref":"#/components/schemas/USDPeruPayoutMethodDetails","title":"USD Peru"},{"$ref":"#/components/schemas/USDChinaPayoutMethodDetails","title":"USD China"},{"$ref":"#/components/schemas/USDPanamaPayoutMethodDetails","title":"USD Panama"},{"$ref":"#/components/schemas/USDHongKongPayoutMethodDetails","title":"USD Hong Kong"}]},"type":{"enum":["usd"],"type":"string"}},"required":["type","details"],"type":"object"},"USDPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/USDDomesticPayoutMethodResponseDetails","title":"USD Domestic"},{"$ref":"#/components/schemas/USDPeruPayoutMethodResponseDetails","title":"USD Peru"},{"$ref":"#/components/schemas/USDChinaPayoutMethodResponseDetails","title":"USD China"},{"$ref":"#/components/schemas/USDPanamaPayoutMethodResponseDetails","title":"USD Panama"},{"$ref":"#/components/schemas/USDHongKongPayoutMethodResponseDetails","title":"USD Hong Kong"}]},"type":{"enum":["usd"],"type":"string"}},"required":["type","details"],"type":"object"},"USDPeruPayoutMethodDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_usd_peru_001","type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usdPeru"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","documentNumber","documentType","bankId"],"type":"object"},"USDPeruPayoutMethodResponseDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****3456","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_usd_peru_001","type":"string"},"documentNumberTruncated":{"description":"Masked document number (format: ****1234)","example":"****5678","type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usdPeru"],"type":"string"}},"required":["type","symbol","accountType","documentType","bankId","bankAccountNumberTruncated","documentNumberTruncated"],"type":"object"},"USDSettlementStrategyConfig":{"properties":{"settlementStrategy":{"description":"The settlement strategy for USD payins","oneOf":[{"$ref":"#/components/schemas/HoldInFiatSettlementStrategy","title":"Hold In Fiat"},{"$ref":"#/components/schemas/AutoOnrampSettlementStrategy","title":"Auto Onramp"}]},"type":{"enum":["usd"],"type":"string"}},"required":["type","settlementStrategy"],"type":"object"},"USDTTRONDepositToken":{"properties":{"blockchain":{"description":"The blockchain of the token","enum":["TRON"],"type":"string"},"contractAddress":{"description":"The contract address of the token","type":"string"},"symbol":{"description":"The symbol of the token","enum":["USDT"],"type":"string"},"type":{"enum":["usdt_tron"],"type":"string"}},"required":["contractAddress","type","symbol","blockchain"],"type":"object"},"UboOwnershipDocumentReference":{"properties":{"documentType":{"description":"The type of UBO ownership document","enum":["SHAREHOLDER_REGISTRY","OWNERSHIP_STRUCTURE","OTHER"],"example":"SHAREHOLDER_REGISTRY","type":"string","x-order":1},"documentId":{"description":"The document ID returned by the document upload endpoint after a successful upload.","format":"uuid","type":"string","x-order":2}},"required":["documentType","documentId"],"type":"object"},"UmidGovernmentId":{"description":"UMID (Philippines) - requires front and back documents","properties":{"countryCode":{"description":"Country Code of UMID Issuer (ISO 3166-1 alpha-2) - Philippines only","enum":["PH"],"example":"PH","title":"Country Code","type":"string"},"type":{"enum":["umid"],"type":"string"},"umidBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of UMID document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"umid_back.pdf"},"title":"UMID Back Document"},"umidFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of UMID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"umid_front.pdf"},"title":"UMID Front Document"},"umidNumber":{"description":"UMID Number","example":"UMID12345678","title":"UMID Number","type":"string"}},"required":["type","umidNumber","countryCode","umidFrontDocument","umidBackDocument"],"type":"object"},"UmidIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"PH","type":"string"},"type":{"enum":["umid"],"type":"string"},"umidBackDocumentId":{"description":"File ID (UUID) of the back of the UMID, from the document upload endpoint.","format":"uuid","type":"string"},"umidFrontDocumentId":{"description":"File ID (UUID) of the front of the UMID, from the document upload endpoint.","format":"uuid","type":"string"},"umidNumber":{"description":"UMID number (Common Reference Number)","example":"0000-1234567-8","type":"string"}},"required":["type","countryCode","umidNumber","umidFrontDocumentId","umidBackDocumentId"],"title":"UMID","type":"object"},"UnknownCounterparty":{"properties":{"type":{"enum":["unknown"],"type":"string"}},"required":["type"],"type":"object"},"UnknownSenderMetadata":{"description":"Placeholder variant for payins where rail-specific sender metadata is not available. For example, if a COP_PSE Payin is created but then subsequently canceled before it is fulfilled.","properties":{"type":{"enum":["unknown"],"type":"string"}},"required":["type"],"type":"object"},"UpdateBusinessCounterpartyInfo":{"properties":{"email":{"description":"Email address for the counterparty. Must be unique within the organization.","format":"email","type":"string"},"name":{"type":"string"},"physicalAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"The physical address of the business counterparty."},"type":{"enum":["business"],"type":"string"}},"required":["type"],"type":"object"},"UpdateCounterpartyRequestBody":{"properties":{"counterparty":{"description":"Partial update of counterparty information. Cannot change type (individual <-> business).","oneOf":[{"$ref":"#/components/schemas/UpdateIndividualCounterpartyInfo","title":"Individual"},{"$ref":"#/components/schemas/UpdateBusinessCounterpartyInfo","title":"Business"}]}},"type":"object"},"UpdateIndividualCounterpartyInfo":{"properties":{"email":{"description":"Email address for the counterparty. Must be unique within the organization.","format":"email","type":"string"},"firstName":{"description":"The first name of the individual","type":"string"},"lastName":{"description":"The last name(s) of the individual","type":"string"},"physicalAddress":{"allOf":[{"$ref":"#/components/schemas/PhysicalAddressVerification"}],"description":"The physical address of the individual counterparty."},"type":{"enum":["individual"],"type":"string"}},"required":["type"],"type":"object"},"UpdateMuralWebhookInput":{"properties":{"categories":{"description":"Event categories to subscribe to","example":["MURAL_ACCOUNT_BALANCE_ACTIVITY"],"items":{"enum":["MURAL_ACCOUNT_BALANCE_ACTIVITY","BUSINESS_VERIFICATION_STATUS","ORGANIZATION_TOS","PAYOUT_REQUEST","PAYIN","COMPLIANCE_REVIEW"],"type":"string"},"type":"array"},"url":{"description":"HTTPS URL endpoint where webhook events will be delivered","example":"https://api.example.com/webhooks","type":"string"}},"type":"object"},"UpdateWebhookStatusInput":{"properties":{"status":{"description":"Webhook status - use to activate/deactivate","enum":["DISABLED","ACTIVE"],"type":"string"}},"required":["status"],"type":"object"},"UploadAssociatedPersonAttestationsRequest":{"properties":{"attestations":{"description":"Associated person attestations to upload. Each attestation type may appear at most once per request.","items":{"oneOf":[{"$ref":"#/components/schemas/AssociatedPersonPersonalInfoAttestation","title":"Associated Person Personal Information"},{"$ref":"#/components/schemas/AssociatedPersonContactInfoAttestation","title":"Associated Person Contact Information"},{"$ref":"#/components/schemas/AssociatedPersonResidentialAddressAttestation","title":"Associated Person Residential Address"},{"$ref":"#/components/schemas/AssociatedPersonTaxInfoAttestation","title":"Associated Person Tax Information"},{"$ref":"#/components/schemas/AssociatedPersonIdentityDocumentAttestation","title":"Associated Person Identity Document"},{"$ref":"#/components/schemas/AssociatedPersonProofOfAddressAttestation","title":"Associated Person Proof of Address"},{"$ref":"#/components/schemas/AssociatedPersonEEAInfoAttestation","title":"Associated Person EEA Information"},{"$ref":"#/components/schemas/AssociatedPersonProofOfSignatoryAuthorityAttestation","title":"Associated Person Proof of Signatory Authority"}]},"minItems":1,"type":"array"}},"required":["attestations"],"type":"object"},"UploadAssociatedPersonAttestationsResponse":{"properties":{"attestations":{"description":"The associated person attestations that were uploaded.","items":{"$ref":"#/components/schemas/AssociatedPersonAttestationResponse"},"type":"array"}},"required":["attestations"],"type":"object"},"UploadAttestationsRequest":{"properties":{"attestations":{"description":"Attestations to upload to the compliance review. Each attestation type may appear at most once per request. Submit the compliance review once all required attestations are uploaded.","items":{"discriminator":{"mapping":{"businessAddress":"#/components/schemas/BusinessAddressAttestation","businessAssociatedPersons":"#/components/schemas/BusinessAssociatedPersonsAttestation","businessContactInfo":"#/components/schemas/BusinessContactInfoAttestation","businessDetails":"#/components/schemas/BusinessDetailsAttestation","businessFinancialInfo":"#/components/schemas/BusinessFinancialInfoAttestation","businessFlowOfFundsDocument":"#/components/schemas/BusinessFlowOfFundsDocumentAttestation","businessFormationDocuments":"#/components/schemas/BusinessFormationDocumentsAttestation","businessIdentification":"#/components/schemas/BusinessIdentificationAttestation","businessOperations":"#/components/schemas/BusinessOperationsAttestation","businessProofOfAddressDocuments":"#/components/schemas/BusinessProofOfAddressDocumentsAttestation","businessTaxInfo":"#/components/schemas/BusinessTaxInfoAttestation","businessUboOwnershipDocuments":"#/components/schemas/BusinessUboOwnershipDocumentsAttestation","individualContactInfo":"#/components/schemas/IndividualContactInfoAttestation","individualEeaInfo":"#/components/schemas/IndividualEEAInfoAttestation","individualFinancialInfo":"#/components/schemas/IndividualFinancialInfoAttestation","individualIdentityDocument":"#/components/schemas/IndividualIdentityDocumentAttestation","individualPersonalInfo":"#/components/schemas/IndividualPersonalInfoAttestation","individualPersonalInfoLight":"#/components/schemas/IndividualPersonalInfoLightAttestation","individualProofOfAddress":"#/components/schemas/IndividualProofOfAddressAttestation","individualResidentialAddress":"#/components/schemas/IndividualResidentialAddressAttestation","individualSelfiePhoto":"#/components/schemas/IndividualSelfiePhotoAttestation","individualSourceOfFunds":"#/components/schemas/IndividualSourceOfFundsAttestation","individualTaxInfo":"#/components/schemas/IndividualTaxInfoAttestation"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/IndividualPersonalInfoLightAttestation","title":"Individual Personal Info (Light Tier)"},{"$ref":"#/components/schemas/IndividualPersonalInfoAttestation","title":"Individual Personal Info (Standard Tier)"},{"$ref":"#/components/schemas/IndividualContactInfoAttestation","title":"Individual Contact Info"},{"$ref":"#/components/schemas/IndividualResidentialAddressAttestation","title":"Individual Residential Address"},{"$ref":"#/components/schemas/IndividualIdentityDocumentAttestation","title":"Individual Identity Document"},{"$ref":"#/components/schemas/IndividualFinancialInfoAttestation","title":"Individual Financial Info"},{"$ref":"#/components/schemas/IndividualTaxInfoAttestation","title":"Individual Tax Info"},{"$ref":"#/components/schemas/IndividualEEAInfoAttestation","title":"Individual EEA Info"},{"$ref":"#/components/schemas/IndividualProofOfAddressAttestation","title":"Individual Proof of Address"},{"$ref":"#/components/schemas/IndividualSourceOfFundsAttestation","title":"Individual Source of Funds"},{"$ref":"#/components/schemas/IndividualSelfiePhotoAttestation","title":"Individual Selfie Photo"},{"$ref":"#/components/schemas/BusinessIdentificationAttestation","title":"Business Identification"},{"$ref":"#/components/schemas/BusinessTaxInfoAttestation","title":"Business Tax Info"},{"$ref":"#/components/schemas/BusinessAddressAttestation","title":"Business Address"},{"$ref":"#/components/schemas/BusinessContactInfoAttestation","title":"Business Contact Info"},{"$ref":"#/components/schemas/BusinessDetailsAttestation","title":"Business Details"},{"$ref":"#/components/schemas/BusinessOperationsAttestation","title":"Business Operations"},{"$ref":"#/components/schemas/BusinessFinancialInfoAttestation","title":"Business Financial Info"},{"$ref":"#/components/schemas/BusinessFormationDocumentsAttestation","title":"Business Formation Documents"},{"$ref":"#/components/schemas/BusinessUboOwnershipDocumentsAttestation","title":"Business UBO Ownership Documents"},{"$ref":"#/components/schemas/BusinessProofOfAddressDocumentsAttestation","title":"Business Proof of Address Documents"},{"$ref":"#/components/schemas/BusinessFlowOfFundsDocumentAttestation","title":"Business Flow of Funds Document"},{"$ref":"#/components/schemas/BusinessAssociatedPersonsAttestation","title":"Business Associated Persons"}]},"minItems":1,"type":"array"}},"required":["attestations"],"type":"object"},"UploadAttestationsResponse":{"properties":{"attestations":{"description":"The attestations that were uploaded.","items":{"$ref":"#/components/schemas/AttestationResponse"},"type":"array"}},"required":["attestations"],"type":"object"},"UploadedDocumentPaginatedResponse":{"properties":{"documents":{"description":"List of documents in the current page.","items":{"$ref":"#/components/schemas/UploadedDocumentResponse"},"type":"array"},"nextId":{"description":"Cursor for the next page of results. Pass this value as the nextId query parameter to retrieve the next page. Absent when there are no more results.","format":"uuid","type":"string"},"totalDocuments":{"description":"Total number of documents matching the query.","type":"number"}},"required":["totalDocuments","documents"],"type":"object"},"UploadedDocumentResponse":{"properties":{"createdAt":{"description":"Timestamp when the document record was created.","format":"date-time","type":"string"},"filename":{"description":"Human-readable filename of the document.","type":"string"},"id":{"description":"Unique identifier for the document.","format":"uuid","type":"string"},"status":{"description":"Current status of the document. `PENDING_UPLOAD` means the file has not yet been received; `UPLOADED` means the file is ready.","enum":["PENDING_UPLOAD","UPLOADED"],"type":"string"},"updatedAt":{"description":"Timestamp when the document was last updated.","format":"date-time","type":"string"}},"required":["id","filename","status","createdAt","updatedAt"],"type":"object"},"UsdChinaDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"address":{"type":"string"},"bankAccountNumber":{"type":"string"},"bankName":{"type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"phoneNumber":{"type":"string"},"swiftBic":{"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usd-china"],"type":"string"}},"required":["type","symbol","bankName","accountType","bankAccountNumber","documentNumber","documentType","phoneNumber","address","swiftBic"],"type":"object"},"UsdDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankRoutingNumber":{"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"transferType":{"description":"The transfer type for USD payouts. Defaults to ACH if not provided.","enum":["ACH","WIRE"],"type":"string"},"type":{"enum":["usd"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","bankRoutingNumber"],"type":"object"},"UsdHongKongDetails":{"properties":{"bankAccountNumber":{"type":"string"},"bankName":{"type":"string"},"swiftBic":{"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usd-hong-kong"],"type":"string"}},"required":["type","symbol","bankName","swiftBic","bankAccountNumber"],"type":"object"},"UsdPanamaDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankName":{"type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usd-panama"],"type":"string"}},"required":["type","symbol","bankName","accountType","bankAccountNumber","documentNumber","documentType"],"type":"object"},"UsdPeruDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"documentNumber":{"type":"string"},"documentType":{"enum":["NATIONAL_ID","PASSPORT","RESIDENT_ID","RUC","TAX_ID"],"type":"string"},"symbol":{"enum":["USD"],"type":"string"},"type":{"enum":["usd-peru"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","documentNumber","documentType"],"type":"object"},"VerificationResponse":{"properties":{"createdAt":{"description":"Creation Timestamp","example":"2023-01-01T00:00:00Z","format":"date-time","title":"Created At","type":"string"},"documents":{"description":"List of Documents Associated with this Verification","items":{"$ref":"#/components/schemas/DocumentResponse"},"title":"Documents","type":"array"},"organizationId":{"description":"Organization Identifier","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid","title":"Organization ID","type":"string"},"type":{"description":"Type of Verification","enum":["business","individual"],"example":"business","title":"Type","type":"string"},"uboVerificationResponses":{"description":"UBO Verification Responses","items":{"$ref":"#/components/schemas/UBOVerificationResponse"},"title":"UBO Verification Responses","type":"array"},"updatedAt":{"description":"Last Update Timestamp","example":"2023-01-01T00:00:00Z","format":"date-time","title":"Updated At","type":"string"},"verificationStatus":{"description":"Verification status","oneOf":[{"$ref":"#/components/schemas/VerificationStatusInactive"},{"$ref":"#/components/schemas/VerificationStatusPending"},{"$ref":"#/components/schemas/VerificationStatusApproved"},{"$ref":"#/components/schemas/VerificationStatusError"},{"$ref":"#/components/schemas/VerificationStatusRejected"}],"title":"Verification Status"}},"required":["organizationId","type","verificationStatus","createdAt","updatedAt","documents"],"type":"object"},"VerificationStatusApproved":{"description":"Indicates the KYC verification has been approved","properties":{"approvedAt":{"description":"Timestamp when the verification was approved","example":"2024-03-21T10:30:00Z","format":"date-time","title":"Approved At","type":"string"},"type":{"enum":["approved"],"type":"string"}},"required":["type","approvedAt"],"type":"object"},"VerificationStatusError":{"description":"Indicates an error occurred during KYC verification","properties":{"details":{"description":"Detailed description of the error that occurred","example":"Failed to process document due to image quality","title":"Error Details","type":"string"},"erroredAt":{"description":"Timestamp when the error occurred","example":"2024-03-21T10:30:00Z","format":"date-time","title":"Errored At","type":"string"},"type":{"enum":["errored"],"type":"string"}},"required":["type","details","erroredAt"],"type":"object"},"VerificationStatusInactive":{"description":"Indicates the KYC verification has not been started","properties":{"type":{"enum":["inactive"],"type":"string"}},"required":["type"],"type":"object"},"VerificationStatusPending":{"description":"Indicates the KYC verification is in progress","properties":{"type":{"enum":["pending"],"type":"string"}},"required":["type"],"type":"object"},"VerificationStatusRejected":{"description":"Indicates the KYC verification was rejected","properties":{"reason":{"description":"Reason why the verification was rejected","example":"Provided documents do not match business registration details","title":"Rejection Reason","type":"string"},"rejectedAt":{"description":"Timestamp when the verification was rejected","example":"2024-03-21T10:30:00Z","format":"date-time","title":"Rejected At","type":"string"},"type":{"enum":["rejected"],"type":"string"}},"required":["type","reason","rejectedAt"],"type":"object"},"VisaGovernmentId":{"description":"Visa - requires front and back documents","properties":{"countryCode":{"description":"Country Code of Visa Issuer (ISO 3166-1 alpha-2)","example":"US","title":"Country Code","type":"string"},"type":{"enum":["visa"],"type":"string"},"visaBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of visa document with filename and base64 content (REQUIRED)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"visa_back.pdf"},"title":"Visa Back Document"},"visaFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of visa document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"visa_front.pdf"},"title":"Visa Front Document"},"visaNumber":{"description":"Visa Number","example":"V12345678","title":"Visa Number","type":"string"}},"required":["type","visaNumber","countryCode","visaFrontDocument","visaBackDocument"],"type":"object"},"VisaIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"US","type":"string"},"type":{"enum":["visa"],"type":"string"},"visaBackDocumentId":{"description":"File ID (UUID) of the back of the visa, from the document upload endpoint.","format":"uuid","type":"string"},"visaFrontDocumentId":{"description":"File ID (UUID) of the front of the visa, from the document upload endpoint.","format":"uuid","type":"string"},"visaNumber":{"description":"Visa number","example":"V12345678","type":"string"}},"required":["type","countryCode","visaNumber","visaFrontDocumentId","visaBackDocumentId"],"title":"Visa","type":"object"},"VoterIdGovernmentId":{"description":"Voter ID - requires front document, back may be required","properties":{"countryCode":{"description":"Country Code of Voter ID Issuer (ISO 3166-1 alpha-2)","example":"MX","title":"Country Code","type":"string"},"type":{"enum":["voterId"],"type":"string"},"voterIdBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of voter ID document with filename and base64 content (required for some countries)","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"voter_id_back.pdf"},"title":"Voter ID Back Document"},"voterIdFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of voter ID document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"voter_id_front.pdf"},"title":"Voter ID Front Document"},"voterIdNumber":{"description":"Voter ID Number","example":"VID12345678","title":"Voter ID Number","type":"string"}},"required":["type","voterIdNumber","countryCode","voterIdFrontDocument"],"type":"object"},"VoterIdIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"MX","type":"string"},"type":{"enum":["voterId"],"type":"string"},"voterIdBackDocumentId":{"description":"File ID (UUID) of the back of the voter ID, from the document upload endpoint.","format":"uuid","type":"string"},"voterIdFrontDocumentId":{"description":"File ID (UUID) of the front of the voter ID, from the document upload endpoint.","format":"uuid","type":"string"},"voterIdNumber":{"description":"Voter ID number","example":"ABC1234567890","type":"string"}},"required":["type","countryCode","voterIdNumber","voterIdFrontDocumentId","voterIdBackDocumentId"],"title":"Voter ID","type":"object"},"WalletDetails":{"properties":{"blockchain":{"description":"The underlying blockchain for the Account. Accounts can only have one blockchain.","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA"],"type":"string"},"walletAddress":{"example":"0x0000000000000000000000000000000000000000","format":"address","type":"string"}},"required":["blockchain","walletAddress"],"type":"object"},"WalletDetailsInput":{"properties":{"blockchain":{"description":"The blockchain network for this payout. SOLANA is accepted only for USD payouts.","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA","SOLANA"],"type":"string"},"token":{"description":"The destination token the recipient will receive. If not specified, the source token will be used.","enum":["USDC","USDT"],"type":"string"},"walletAddress":{"description":"The destination wallet address. Accepts EVM addresses (0x-prefixed, 40 hex chars, e.g. `0x0000000000000000000000000000000000000000`) or Solana addresses (base58-encoded 32-byte pubkey, e.g. `EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v`). Must match the selected blockchain.","example":"0x0000000000000000000000000000000000000000","type":"string"}},"required":["walletAddress","blockchain"],"type":"object"},"WalletDetailsResponse":{"properties":{"blockchain":{"description":"The blockchain network. SOLANA is only returned for wallets registered on the USD payout path.","enum":["ETHEREUM","POLYGON","BASE","CELO","PLASMA","SOLANA"],"type":"string"},"walletAddress":{"description":"The wallet address for blockchain payouts","type":"string"}},"required":["walletAddress","blockchain"],"type":"object"},"WebhookPingHttpError":{"description":"The endpoint was reached but responded with a non-2xx status.","properties":{"errorDetails":{"description":"Human-readable description of the non-2xx response.","type":"string"},"responseStatusCode":{"description":"Non-2xx HTTP status code returned by the endpoint.","maximum":599,"minimum":100,"type":"integer"},"responseTimeMs":{"description":"Round-trip time of the ping request, in milliseconds.","minimum":0,"type":"integer"},"type":{"enum":["httpError"],"type":"string"}},"required":["type","responseStatusCode","responseTimeMs","errorDetails"],"type":"object"},"WebhookPingSuccess":{"description":"The endpoint received the ping and responded with a 2xx status.","properties":{"responseStatusCode":{"description":"HTTP status code returned by the endpoint.","maximum":299,"minimum":200,"type":"integer"},"responseTimeMs":{"description":"Round-trip time of the ping request, in milliseconds.","minimum":0,"type":"integer"},"type":{"enum":["success"],"type":"string"}},"required":["type","responseStatusCode","responseTimeMs"],"type":"object"},"WebhookPingUnreachable":{"description":"The endpoint could not be reached (timeout, DNS failure, connection refused, or an over-cap response body).","properties":{"errorDetails":{"description":"Human-readable description of why the endpoint was unreachable.","type":"string"},"responseTimeMs":{"description":"Time elapsed before the ping failed, in milliseconds.","minimum":0,"type":"integer"},"type":{"enum":["unreachable"],"type":"string"}},"required":["type","responseTimeMs","errorDetails"],"type":"object"},"WirePayinAmount":{"properties":{"currencySymbol":{"enum":["USD"],"type":"string"},"value":{"description":"The amount in cents (e.g., \"2500\" represents 25.00).","example":"2500","type":"string"}},"required":["value","currencySymbol"],"type":"object"},"WirePayinRail":{"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/WirePayinAmount"}],"description":"The amount to simulate. Must be denominated in USD."},"type":{"enum":["wire"],"type":"string"}},"required":["type","amount"],"type":"object"},"WireSenderMetadata":{"properties":{"bankBeneficiaryName":{"description":"The name of the bank beneficiary","type":"string"},"bankName":{"description":"The name of the bank","type":"string"},"imad":{"description":"The IMAD number","type":"string"},"senderName":{"description":"The name of the sender","type":"string"},"type":{"enum":["wire"],"type":"string"},"wireRoutingNumber":{"description":"The wire routing number","type":"string"}},"required":["type","wireRoutingNumber","bankName","bankBeneficiaryName","imad"],"type":"object"},"WorkPermitGovernmentId":{"description":"Work permit - may require front and back documents","properties":{"countryCode":{"description":"Country Code of Work Permit Issuer (ISO 3166-1 alpha-2)","example":"SG","title":"Country Code","type":"string"},"type":{"enum":["workPermit"],"type":"string"},"workPermitBackDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdBackDocumentUpload"}],"description":"Back of work permit document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"work_permit_back.pdf"},"title":"Work Permit Back Document"},"workPermitFrontDocument":{"allOf":[{"$ref":"#/components/schemas/GovernmentIdFrontDocumentUpload"}],"description":"Front of work permit document with filename and base64 content","example":{"documentContent":"data:application/pdf;base64,JVBERi0xLjQKJcOkw7zDtsO...","filename":"work_permit_front.pdf"},"title":"Work Permit Front Document"},"workPermitNumber":{"description":"Work Permit Number","example":"WP12345678","title":"Work Permit Number","type":"string"}},"required":["type","workPermitNumber","countryCode","workPermitFrontDocument"],"type":"object"},"WorkPermitIdentityDocument":{"properties":{"countryCode":{"description":"ISO 3166-1 alpha-2 country code of the government authority that issued this document.","example":"GB","type":"string"},"type":{"enum":["workPermit"],"type":"string"},"workPermitBackDocumentId":{"description":"File ID (UUID) of the back of the work permit, from the document upload endpoint.","format":"uuid","type":"string"},"workPermitFrontDocumentId":{"description":"File ID (UUID) of the front of the work permit, from the document upload endpoint.","format":"uuid","type":"string"},"workPermitNumber":{"description":"Work permit number","example":"WP1234567","type":"string"}},"required":["type","countryCode","workPermitNumber","workPermitFrontDocumentId","workPermitBackDocumentId"],"title":"Work Permit","type":"object"},"ZARDomesticPayoutMethodDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_zar_001","type":"string"},"symbol":{"enum":["ZAR"],"type":"string"},"type":{"enum":["zarDomestic"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber","bankId"],"type":"object"},"ZARDomesticPayoutMethodResponseDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumberTruncated":{"description":"Masked bank account number (format: ****1234)","example":"****6789","type":"string"},"bankId":{"description":"Bank ID from the /counterparties/payment-methods/supported-banks endpoint","example":"bank_zar_001","type":"string"},"symbol":{"enum":["ZAR"],"type":"string"},"type":{"enum":["zarDomestic"],"type":"string"}},"required":["type","symbol","accountType","bankId","bankAccountNumberTruncated"],"type":"object"},"ZARPayoutMethod":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/ZARDomesticPayoutMethodDetails","title":"ZAR Domestic"}]},"type":{"enum":["zar"],"type":"string"}},"required":["type","details"],"type":"object"},"ZARPayoutMethodInfo":{"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/ZARDomesticPayoutMethodResponseDetails","title":"ZAR Domestic"}]},"type":{"enum":["zar"],"type":"string"}},"required":["type","details"],"type":"object"},"ZarDetails":{"properties":{"accountType":{"enum":["CHECKING","SAVINGS"],"type":"string"},"bankAccountNumber":{"type":"string"},"symbol":{"enum":["ZAR"],"type":"string"},"type":{"enum":["zar"],"type":"string"}},"required":["type","symbol","accountType","bankAccountNumber"],"type":"object"}},"securitySchemes":{"bearer":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"info":{"contact":{},"description":"Mural's API for programmatic global payments.","title":"Mural API","version":"1.0"},"openapi":"3.0.0","paths":{"/api/accounts":{"get":{"description":"Get all Accounts associated with the provided Organization ID","operationId":"getAccounts","parameters":[{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Account"},"type":"array"}}},"description":"All Accounts associated with an Organization"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get all Accounts","tags":["Accounts"]},"post":{"description":"Creates a Mural Account that you can deposit funds into and perform payouts from.","operationId":"createAccount","parameters":[{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewAccountInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Create an Account"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Create an Account","tags":["Accounts"]}},"/api/accounts/{id}":{"get":{"description":"Get an Account identified by the provided ID.","operationId":"getAccount","parameters":[{"description":"Mural Account ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Mural Account"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get an Account","tags":["Accounts"]}},"/api/accounts/{id}/set-developer-fees":{"put":{"description":"Sets or updates the developer fee configurations for a specific Account. Multiple currencies can be configured in a single request. Developer fees can only be configured for child organizations, so this request must be made on behalf of a child organization using the `on-behalf-of` header.","operationId":"setDeveloperFees","parameters":[{"description":"Mural Account ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDeveloperFeesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Set developer fees for an Account"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Set developer fees for an Account","tags":["Accounts"]}},"/api/accounts/{id}/set-settlement-strategy":{"put":{"description":"Sets or updates the settlement strategy for a specific Account. The settlement strategy controls how incoming payins are settled: either held as fiat, or automatically on-ramped to the Account destination token.","operationId":"setSettlementStrategy","parameters":[{"description":"Mural Account ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetSettlementStrategyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Set settlement strategy for an Account"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Set settlement strategy for an Account","tags":["Accounts"]}},"/api/approvers/end-user-custodial/initiate-challenge":{"post":{"description":"Initiates an email challenge to validate the action of an approver. This endpoint should only be used in end-user custodial payout flows.","operationId":"initiateEndUserCustodialChallenge","parameters":[{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateChallengeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateChallengeResponse"}}},"description":"Challenge initiated successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Initiate an end-user custodial challenge for an approver","tags":["Approvers"]}},"/api/compliance/{organizationId}/associated-persons":{"get":{"description":"Returns all associated persons for the organization, including each associated person's uploaded attestations.","operationId":"listAssociatedPersons","parameters":[{"in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAssociatedPersonsResponse"}}},"description":"Associated persons returned successfully."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"List associated persons","tags":["Associated Persons"]},"post":{"description":"Creates an associated person — a beneficial owner or control person — and attaches them to the organization. To include them in a business compliance review, reference their ID from the business associated persons attestation. An organization may have one control person and up to four beneficial owners. The same individual can act as both.","operationId":"createAssociatedPerson","parameters":[{"in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssociatedPersonRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociatedPersonResource"}}},"description":"Associated person created."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"422":{"description":"ControlPersonAlreadyExistsException\n\nMaxBeneficialOwnersExceededException"}},"security":[{"bearer":[]}],"summary":"Create an associated person","tags":["Associated Persons"]}},"/api/compliance/{organizationId}/associated-persons/{associatedPersonId}/attestations":{"put":{"description":"Upload one or more attestations for an associated person. Re-uploading an attestation type replaces the previous value. Only attestation types defined for associated persons (personal info, contact, residential address, tax info, identity document, and proof of address) are accepted here — business-level attestations belong on the compliance review endpoint.","operationId":"uploadAssociatedPersonAttestations","parameters":[{"in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"associatedPersonId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadAssociatedPersonAttestationsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadAssociatedPersonAttestationsResponse"}}},"description":"Associated person attestations uploaded successfully."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Upload attestations for an associated person","tags":["Associated Persons"]}},"/api/compliance/{organizationId}/reviews":{"get":{"description":"Returns all compliance reviews for the organization, including required and uploaded attestations.","operationId":"listReviews","parameters":[{"in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"reviews":{"items":{"oneOf":[{"$ref":"#/components/schemas/IndividualComplianceReviewResponse","title":"Individual compliance review"},{"$ref":"#/components/schemas/BusinessComplianceReviewResponse","title":"Business compliance review"}]},"type":"array"}},"required":["reviews"],"type":"object"}}},"description":"Compliance reviews returned successfully."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"List compliance reviews","tags":["Compliance"]},"post":{"description":"Creates a compliance review for organization onboarding submissions.","operationId":"createReview","parameters":[{"in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an `idempotency-replayed: true` response header. Keys expire after 24 hours.","in":"header","name":"idempotency-key","required":false,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateIndividualComplianceReviewRequest","title":"Individual compliance review"},{"$ref":"#/components/schemas/CreateBusinessComplianceReviewRequest","title":"Business compliance review"}]}}},"description":"Individual or business compliance review.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateIndividualComplianceReviewResponse","title":"Individual compliance review"},{"$ref":"#/components/schemas/CreateBusinessComplianceReviewResponse","title":"Business compliance review"}]}}},"description":"Compliance review created."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"409":{"description":"IdempotencyConflictError"},"422":{"description":"IdempotencyKeyExpiredError"}},"security":[{"bearer":[]}],"summary":"Create a compliance review","tags":["Compliance"]}},"/api/compliance/{organizationId}/reviews/{complianceReviewId}":{"get":{"description":"Returns the compliance review including required and uploaded attestations.","operationId":"getReview","parameters":[{"in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"complianceReviewId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndividualComplianceReviewResponse","title":"Individual compliance review"},{"$ref":"#/components/schemas/BusinessComplianceReviewResponse","title":"Business compliance review"}]}}},"description":"Compliance review returned successfully."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get a compliance review","tags":["Compliance"]}},"/api/compliance/{organizationId}/reviews/{complianceReviewId}/attestations":{"put":{"description":"Upload one or more attestations to a draft compliance review. Re-uploading an attestation type replaces the previous instance of that attestation type.","operationId":"uploadAttestations","parameters":[{"in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"complianceReviewId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadAttestationsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadAttestationsResponse"}}},"description":"Attestations uploaded successfully."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Upload attestations to a compliance review","tags":["Compliance"]}},"/api/compliance/{organizationId}/reviews/{complianceReviewId}/submit":{"post":{"description":"Submits the compliance review for evaluation. The review must contain every required attestation for its tier.","operationId":"submitReview","parameters":[{"in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"complianceReviewId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitComplianceReviewRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"discriminator":{"mapping":{"business":"#/components/schemas/SubmitBusinessComplianceReviewResponse","individual":"#/components/schemas/SubmitIndividualComplianceReviewResponse"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/SubmitIndividualComplianceReviewResponse","title":"Individual compliance review submitted"},{"$ref":"#/components/schemas/SubmitBusinessComplianceReviewResponse","title":"Business compliance review submitted"}]}}},"description":"Compliance review submitted successfully."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"412":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttestationValidationsRejectedExceptionBody"}}},"description":"AttestationValidationsRejectedException"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingAttestationsExceptionBody"}}},"description":"MissingAttestationsException"}},"security":[{"bearer":[]}],"summary":"Submit a compliance review","tags":["Compliance"]}},"/api/counterparties":{"post":{"description":"Creates a new counterparty (recipient) that can be referenced in future payouts. The counterparty information is stored and can be reused across multiple payout requests.","operationId":"createCounterparty","parameters":[{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCounterpartyRequestBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndividualCounterparty","title":"Individual"},{"$ref":"#/components/schemas/BusinessCounterparty","title":"Business"}]}}},"description":"The successfully created counterparty"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Create a Counterparty","tags":["Counterparties"]}},"/api/counterparties/counterparty/{id}":{"get":{"description":"Retrieves a single counterparty by ID.","operationId":"getCounterpartyById","parameters":[{"description":"Counterparty ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndividualCounterparty","title":"Individual"},{"$ref":"#/components/schemas/BusinessCounterparty","title":"Business"}]}}},"description":"The requested counterparty"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get a Counterparty","tags":["Counterparties"]},"put":{"description":"Updates an existing counterparty with partial data. Note: You cannot change the type (individual <-> business).","operationId":"updateCounterparty","parameters":[{"description":"Counterparty ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCounterpartyRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndividualCounterparty","title":"Individual"},{"$ref":"#/components/schemas/BusinessCounterparty","title":"Business"}]}}},"description":"The updated counterparty"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Update a Counterparty","tags":["Counterparties"]}},"/api/counterparties/counterparty/{id}/archive":{"post":{"description":"Archives a counterparty. The counterparty will no longer be available for use in new payouts. All associated payout methods are also archived.","operationId":"archiveCounterparty","parameters":[{"description":"Counterparty ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Counterparty archived successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"404":{"description":"Counterparty not found or has already been archived"}},"security":[{"bearer":[]}],"summary":"Archive a Counterparty","tags":["Counterparties"]}},"/api/counterparties/payment-methods/supported-banks":{"get":{"description":"Returns bank selection requirements for specified payout method types (rails). If the payment method type requires a specific bank, you'll be required to provide a bankId.","operationId":"getBanksForPayoutMethods","parameters":[{"description":"Payout method types (rails) to get bank requirements for. These are the discriminator values used in payout method creation (e.g., \"usdPeru\", \"brlPixPhone\", \"usdDomestic\").","in":"query","name":"payoutMethodTypes","required":true,"schema":{"items":{"enum":["usdDomestic","usdPeru","usdChina","usdPanama","usdHongKong","arsAlias","arsAccountNumber","pixPhone","pixEmail","pixDocument","pixBankAccount","wire","copDomestic","copBreB","copCobreBalance","eurSepa","mxnDomestic","clpDomestic","penDomestic","bobDomestic","crcDomestic","zarDomestic"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"arsAccountNumber":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"arsAlias":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"bobDomestic":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"clpDomestic":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"copBreB":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"copCobreBalance":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"copDomestic":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"crcDomestic":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"eurSepa":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"mxnDomestic":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"penDomestic":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"pixBankAccount":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"pixDocument":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"pixEmail":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"pixPhone":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"usdChina":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"usdDomestic":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"usdHongKong":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"usdPanama":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"usdPeru":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"wire":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]},"zarDomestic":{"oneOf":[{"$ref":"#/components/schemas/BankSelectionRequired"},{"$ref":"#/components/schemas/BankSelectionNotRequired"}]}},"type":"object"}}},"description":"Map of payout method types to their bank selection requirements. Only the payout method types specified in the request will be present in the response."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get Bank Requirements for Payout Method Types","tags":["Payout Methods"]}},"/api/counterparties/search":{"post":{"description":"Search and retrieve counterparties for the organization.","operationId":"searchCounterparties","parameters":[{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"nextId","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCounterpartiesRequestInfo"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CounterpartyPaginatedResponse"}}},"description":"Paginated list of counterparties"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Search Counterparties","tags":["Counterparties"]}},"/api/counterparties/{id}/payout-methods":{"post":{"description":"Creates a new payout method for a counterparty. This stores the payment details (bank account, blockchain address, etc.) that can be referenced when creating a payout within a payout requests.","operationId":"createPayoutMethod","parameters":[{"description":"Counterparty ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePayoutMethodRequestBody"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutMethodResponse"}}},"description":"The successfully created payout method"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalCounterpartyInformationRequiredBody"}}},"description":"AdditionalCounterpartyInformationRequired"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Create a Payout Method","tags":["Payout Methods"]}},"/api/counterparties/{id}/payout-methods/search":{"post":{"description":"Search and retrieve payout methods for a specific counterparty.","operationId":"searchPayoutMethods","parameters":[{"description":"Counterparty ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"nextId","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayoutMethodsRequestInfo"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutMethodPaginatedResponse"}}},"description":"Paginated list of payout methods"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Search Payout Methods","tags":["Payout Methods"]}},"/api/counterparties/{id}/payout-methods/{payoutMethodId}":{"get":{"description":"Retrieves a single payout method by ID for a counterparty.","operationId":"getPayoutMethodById","parameters":[{"description":"Counterparty ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Payout Method ID","in":"path","name":"payoutMethodId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutMethodResponse"}}},"description":"The requested payout method"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get a Payout Method","tags":["Payout Methods"]}},"/api/counterparties/{id}/payout-methods/{payoutMethodId}/archive":{"post":{"description":"Archives a payout method. The payout method will no longer be available for use in new payouts.","operationId":"archivePayoutMethod","parameters":[{"description":"Counterparty ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Payout Method ID","in":"path","name":"payoutMethodId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Payout method archived successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"404":{"description":"Counterparty or payout method not found, or payout method has already been archived"}},"security":[{"bearer":[]}],"summary":"Archive a Payout Method","tags":["Payout Methods"]}},"/api/documents":{"get":{"description":"Returns a paginated list of documents for the organization.","operationId":"listDocuments","parameters":[{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"nextId","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadedDocumentPaginatedResponse"}}},"description":"Documents returned successfully."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"List documents","tags":["Documents"]}},"/api/documents/generate-upload-url":{"post":{"description":"Returns a one-time upload URL plus the form fields you need to attach. Send a `multipart/form-data` POST to the URL with each `uploadUrlFormFields` entry as a form field, then the file field last. The URL is valid for 60 minutes. Maximum file size is 10 MB.","operationId":"generateUploadUrl","parameters":[{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}},{"description":"Required UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an `idempotency-replayed: true` response header. Keys expire after 24 hours.","in":"header","name":"idempotency-key","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateUploadUrlRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateUploadUrlResponse"}}},"description":"Upload URL generated."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"409":{"description":"IdempotencyConflictError"},"422":{"description":"IdempotencyKeyExpiredError"}},"security":[{"bearer":[]}],"summary":"Get an upload URL for a document","tags":["Documents"]}},"/api/documents/{documentId}":{"delete":{"description":"Removes a document from the organization. The document will no longer be accessible through the API.","operationId":"deleteDocument","parameters":[{"in":"path","name":"documentId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Document deleted."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"404":{"description":"Document not found."}},"security":[{"bearer":[]}],"summary":"Delete a document","tags":["Documents"]},"get":{"description":"Returns the document details.","operationId":"getDocument","parameters":[{"in":"path","name":"documentId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadedDocumentResponse"}}},"description":"Document returned successfully."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"404":{"description":"Document not found."}},"security":[{"bearer":[]}],"summary":"Get a document","tags":["Documents"]}},"/api/organizations":{"post":{"operationId":"createOrganization","parameters":[],"requestBody":{"content":{"application/json":{"examples":{"Business Organization":{"description":"Example payload for creating a business organization","summary":"Business Organization","value":{"businessName":"Acme Corp","email":"contact@acme.com","type":"business"}},"End-User Custodial Business":{"description":"Example payload for creating an end-user custodial business organization","summary":"End-User Custodial Business Organization","value":{"approvers":[{"email":"alice@techstartup.com","name":"Alice Johnson"},{"email":"bob@techstartup.com","name":"Bob Wilson"}],"businessName":"Tech Startup Inc","email":"contact@techstartup.com","type":"endUserCustodialBusiness"}},"End-User Custodial Individual":{"description":"Example payload for creating an end-user custodial individual organization","summary":"End-User Custodial Individual Organization","value":{"email":"jane.smith@example.com","firstName":"Jane","lastName":"Smith","type":"endUserCustodialIndividual"}},"Individual Organization":{"description":"Example payload for creating an individual organization","summary":"Individual Organization","value":{"email":"john.doe@example.com","firstName":"John","lastName":"Doe","type":"individual"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/IndividualOrgRequest","title":"Individual Organization"},{"$ref":"#/components/schemas/BusinessOrgRequest","title":"Business Organization"},{"$ref":"#/components/schemas/IndividualEndUserCustodialOrgRequest","title":"Individual End-User Custodial Organization"},{"$ref":"#/components/schemas/BusinessEndUserCustodialOrgRequest","title":"Business End-User Custodial Organization"}]}}},"description":"Information needed to create a new Organization","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndividualOrganization","title":"Individual Organization"},{"$ref":"#/components/schemas/BusinessOrganization","title":"Business Organization"},{"$ref":"#/components/schemas/IndividualEndUserCustodialOrganization","title":"Individual End-User Custodial Organization"},{"$ref":"#/components/schemas/BusinessEndUserCustodialOrganization","title":"Business End-User Custodial Organization"}]}}},"description":"Newly created Organization."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Create an Organization","tags":["Organizations"]}},"/api/organizations/search":{"post":{"description":"Get all Organizations created in Mural subject to the provided filter.","operationId":"getOrganizations","parameters":[{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"nextId","required":false,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMuralOrganizationRequestInfo"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponse"},{"properties":{"results":{"items":{"oneOf":[{"$ref":"#/components/schemas/IndividualOrganization","title":"Individual Organization"},{"$ref":"#/components/schemas/BusinessOrganization","title":"Business Organization"},{"$ref":"#/components/schemas/IndividualEndUserCustodialOrganization","title":"Individual End-User Custodial Organization"},{"$ref":"#/components/schemas/BusinessEndUserCustodialOrganization","title":"Business End-User Custodial Organization"}]},"type":"array"}}}]}}},"description":"Paginated list of Organizations created in Mural"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Search Organizations","tags":["Organizations"]}},"/api/organizations/{id}":{"get":{"description":"Get an Organization by the provided ID.","operationId":"getOrganization","parameters":[{"description":"Organization ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndividualOrganization","title":"Individual Organization"},{"$ref":"#/components/schemas/BusinessOrganization","title":"Business Organization"},{"$ref":"#/components/schemas/IndividualEndUserCustodialOrganization","title":"Individual End-User Custodial Organization"},{"$ref":"#/components/schemas/BusinessEndUserCustodialOrganization","title":"Business End-User Custodial Organization"}]}}},"description":"Successful Organization response."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get an Organization","tags":["Organizations"]}},"/api/organizations/{id}/kyc-link/v2":{"get":{"description":"Returns a new KYC link with token expiry information. A fresh token is generated on each call. The token is valid for 24 hours. The organization must have accepted the Terms of Service before a KYC link can be generated.","operationId":"getOrganizationKycLinkV2","parameters":[{"description":"Organization ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycLinkResponse"}}},"description":"KYC link with expiry information"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"404":{"description":"Organization not found or does not belong to the authenticated parent organization"},"412":{"description":"Precondition failed. Either KYB Delegation is enabled for the parent organization, or the organization has not accepted the Terms of Service."}},"security":[{"bearer":[]}],"summary":"Get a hosted KYC link for an Organization (v2)","tags":["Organizations"]}},"/api/organizations/{id}/tos-link":{"get":{"description":"The page at the returned URL allows users to review and accept the terms of service for the organization.","operationId":"getOrganizationTosLink","parameters":[{"description":"Organization ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Hosted terms of service link","properties":{"tosLink":{"format":"url","type":"string"}},"type":"object"}}},"description":"Successful terms of service link response"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get a hosted terms of service link for an Organization","tags":["Organizations"]}},"/api/payins/exchange-rate":{"post":{"description":"Gets the exchange rate for a given fiat amount and payin rail.","operationId":"getPayinExchangeRate","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPayinExchangeRateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayinExchangeRate"}}},"description":"Exchange rate for payin"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get exchange rate for payin","tags":["Payins"]}},"/api/payins/payin":{"post":{"description":"Creates a new Payin Intent.","operationId":"createPayin","parameters":[{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPayinRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePayinResponse"}}},"description":"Created Payin Intent"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayinMinimumNotMetErrorBody"}}},"description":"PayinMinimumNotMetError"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Create a Payin Intent","tags":["Payins"]}},"/api/payins/payin/{id}":{"get":{"description":"Gets the Payin identified by the provided ID.","operationId":"getPayin","parameters":[{"description":"Payin ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payin"}}},"description":"Returned Payin"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get a Payin","tags":["Payins"]}},"/api/payins/payin/{id}/cancel":{"post":{"description":"Cancels the Payin identified by the provided ID.","operationId":"cancelPayin","parameters":[{"description":"Payin ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Payin canceled successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Cancel a Payin","tags":["Payins"]}},"/api/payins/search":{"post":{"description":"Get all Payins associated with the provided Organization ID.","operationId":"searchPayins","parameters":[{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"nextId","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Filter payins by PayinBatch ID.","in":"query","name":"payinBatchId","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponse"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Payin"},"type":"array"}}}]}}},"description":"Returned Payins"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Search Payins","tags":["Payins"]}},"/api/payouts/bank-details":{"get":{"description":"Gets the required bank names for a given fiat and rail code. This endpoint should be used to validate the bank name provided in the payout request if you are sending a fiat payout.","operationId":"getBankDetails","parameters":[{"description":"The fiat and rail code.","in":"query","name":"fiatCurrencyAndRail","required":true,"schema":{"items":{"enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanksInfo"}}},"description":"Get bank names required by fiat and rail code"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get bank details","tags":["Payouts"]}},"/api/payouts/fees/fiat-to-token":{"post":{"description":"Computes the estimated original token amount required and estimated fees for a recipient to receive the provided fiat currency amount.","operationId":"getPayoutFeesForFiatAmount","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPayoutFiatFeesInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"oneOf":[{"$ref":"#/components/schemas/FiatPayoutFeeSuccess"},{"$ref":"#/components/schemas/FiatPayoutFeeError"}]},"type":"array"}}},"description":"Get payout fees for fiat amount"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get fees for fiat amount","tags":["Payouts"]}},"/api/payouts/fees/token-to-fiat":{"post":{"description":"Computes the expected fees for a given token amount and payout fiat currency.","operationId":"getPayoutFeesForTokenAmount","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPayoutTokenFeesInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"oneOf":[{"$ref":"#/components/schemas/TokenPayoutFeeSuccess"},{"$ref":"#/components/schemas/TokenPayoutFeeError"}]},"type":"array"}}},"description":"Payout fees for token amount"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get fees for token amount","tags":["Payouts"]}},"/api/payouts/payout":{"post":{"description":"Creates a Payout Request. The Payout Request can have multiple recipients, each of which can be a fiat or blockchain payout.","operationId":"createPayoutRequest","parameters":[{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}},{"description":"Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an `idempotency-replayed: true` response header. Keys expire after 24 hours.","in":"header","name":"idempotency-key","required":false,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewPayoutRequestInput"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"}}},"description":"The successfully created Payout Request"},"400":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PayoutMinimumNotMetErrorBody","title":"Payout Minimum Not Met Error"},{"$ref":"#/components/schemas/AdditionalRecipientInformationRequiredBody","title":"Additional Recipient Information Required"}]}}},"description":"Payout Minimum Not Met Error | Additional Recipient Information Required"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycUpgradeRequiredExceptionBody"}}},"description":"KycUpgradeRequiredException"},"409":{"description":"IdempotencyConflictError"},"412":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutMethodErrorBody"}}},"description":"PayoutMethodError"},"422":{"description":"IdempotencyKeyExpiredError"},"428":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutComplianceValidationFailedErrorBody"}}},"description":"PayoutComplianceValidationFailedError"}},"security":[{"bearer":[]}],"summary":"Create a Payout Request","tags":["Payouts"]}},"/api/payouts/payout/end-user-custodial/body-to-sign/{id}":{"get":{"description":"Retrieves the Payout Request Body identified by the provided ID. This endpoint should only be used as part of an end-user custodial payout flow.","operationId":"getPayoutRequestPayload","parameters":[{"description":"Payout request ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":true,"example":{"to":"0x41E94Eb019C0762f9Bfcf9Fb1E58725BfB0e7582","value":"10"},"type":"object"}}},"description":"Returned Payout Request Payload (generic JSON object)"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get a Payout Request Body used to sign the Payout","tags":["Payouts"]}},"/api/payouts/payout/end-user-custodial/cancel/{id}":{"post":{"description":"Cancels a Payout Request.","operationId":"cancelEndUserCustodialPayoutRequest","parameters":[{"description":"Payout request ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":true,"schema":{"type":"string"}},{"description":"Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an `idempotency-replayed: true` response header. Keys expire after 24 hours.","in":"header","name":"idempotency-key","required":false,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Successfully canceled Payout Request"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"409":{"description":"IdempotencyConflictError"},"422":{"description":"IdempotencyKeyExpiredError"}},"security":[{"bearer":[]}],"summary":"Cancel an end-user custodial Payout Request","tags":["Payouts"]}},"/api/payouts/payout/end-user-custodial/execute/{id}":{"post":{"description":"Executes a Payout Request using an end-user custodial signature.","operationId":"executeEndUserCustodialPayoutRequest","parameters":[{"description":"Payout request ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":true,"schema":{"type":"string"}},{"description":"Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an `idempotency-replayed: true` response header. Keys expire after 24 hours.","in":"header","name":"idempotency-key","required":false,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteEndUserCustodialMuralTransferRequestInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"}}},"description":"Successfully executed Payout Request via an end-user custodial signature"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"409":{"description":"TransactionInProgressError\n\nIdempotencyConflictError"},"412":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PayoutQuoteExpiredExceptionBody","title":"Payout Quote Expired Exception"},{"$ref":"#/components/schemas/InsufficientBalanceErrorBody","title":"Insufficient Balance Error"}]}}},"description":"Payout Quote Expired Exception | Insufficient Balance Error"},"422":{"description":"IdempotencyKeyExpiredError"}},"security":[{"bearer":[]}],"summary":"Execute an end-user custodial Payout Request","tags":["Payouts"]}},"/api/payouts/payout/{id}":{"get":{"description":"Gets the Payout Request identified by the provided ID.","operationId":"getPayoutRequest","parameters":[{"description":"Payout request ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"}}},"description":"Returned Payout Request"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get a Payout Request","tags":["Payouts"]}},"/api/payouts/payout/{id}/cancel":{"post":{"operationId":"cancelPayoutRequest","parameters":[{"description":"Payout request ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}},{"description":"Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an `idempotency-replayed: true` response header. Keys expire after 24 hours.","in":"header","name":"idempotency-key","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Transfer API key required to execute this request.","in":"header","name":"transfer-api-key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"}}},"description":"Canceled payout request."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"409":{"description":"IdempotencyConflictError"},"422":{"description":"IdempotencyKeyExpiredError"}},"security":[{"bearer":[]}],"summary":"Cancel a Payout Request","tags":["Payouts"]}},"/api/payouts/payout/{id}/execute":{"post":{"operationId":"executePayoutRequest","parameters":[{"description":"Payout request ID","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}},{"description":"Optional UUID to safely retry requests without creating duplicate operations. Subsequent requests with the same key and identical body return the original cached response with an `idempotency-replayed: true` response header. Keys expire after 24 hours.","in":"header","name":"idempotency-key","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Transfer API key required to execute this request.","in":"header","name":"transfer-api-key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePayoutRequestInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutRequest"}}},"description":"Successfully executed Payout Request"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"409":{"description":"TransactionInProgressError\n\nIdempotencyConflictError"},"412":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PayoutQuoteExpiredExceptionBody","title":"Payout Quote Expired Exception"},{"$ref":"#/components/schemas/InsufficientBalanceErrorBody","title":"Insufficient Balance Error"}]}}},"description":"Payout Quote Expired Exception | Insufficient Balance Error"},"422":{"description":"IdempotencyKeyExpiredError"}},"security":[{"bearer":[]}],"summary":"Execute a Payout Request","tags":["Payouts"]}},"/api/payouts/search":{"post":{"description":"Get all Payout Requests associated with the provided Organization ID and filtered by the provided statuses.","operationId":"searchPayoutRequests","parameters":[{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"nextId","required":false,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuralSearchPayoutRequestsInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponse"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/PayoutRequest"},"type":"array"}}}]}}},"description":"Returned Payout Requests"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Search Payout Requests","tags":["Payouts"]}},"/api/sandbox/simulate/complianceReview/{organizationId}":{"post":{"description":"Simulates an approved compliance review for a child organization, skipping the real KYB/KYC flow. Approval completes asynchronously after a couple of minutes. Sandbox only.","operationId":"simulateComplianceReview","parameters":[{"description":"The child organization whose compliance review to simulate.","in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Simulated compliance review triggered."},"400":{"description":"The child organization has already begun or completed a compliance review."},"401":{"description":"`organizationId` is not a child of the parent that owns the API key."},"403":{"description":"Not available in production."}},"security":[{"bearer":[]}],"summary":"Bypass a compliance review for a child organization","tags":["Sandbox"]}},"/api/sandbox/simulate/complianceReview/{organizationId}/{complianceReviewId}/transition":{"post":{"description":"Drives a child organization's compliance review to a chosen lifecycle state, producing the same state change and `compliance_review_status_changed` webhook event the real transition would. Sandbox only.","operationId":"simulateComplianceReviewTransition","parameters":[{"description":"The child organization that owns the review.","in":"path","name":"organizationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The compliance review to transition.","in":"path","name":"complianceReviewId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateComplianceReviewTransitionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IndividualComplianceReviewResponse","title":"Individual compliance review"},{"$ref":"#/components/schemas/BusinessComplianceReviewResponse","title":"Business compliance review"}]}}},"description":"The updated compliance review."},"400":{"description":"The request body is malformed for the requested target state."},"401":{"description":"`organizationId` is not a child of the parent that owns the API key."},"403":{"description":"Not available in production."},"404":{"description":"No compliance review with that id exists for the organization."},"409":{"description":"The transition is invalid from the review's current state."}},"security":[{"bearer":[]}],"summary":"Simulate a compliance review state transition for a child organization","tags":["Sandbox"]}},"/api/sandbox/simulate/payin":{"post":{"description":"Triggers a simulated inbound payin on a sandbox deposit account. Useful for testing payin receipt flows without initiating a real bank transfer. Only available in sandbox environments.","operationId":"simulatePayin","parameters":[{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateSandboxPayinRequest"}}},"required":true},"responses":{"201":{"description":"The simulated payin was successfully initiated."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"404":{"description":"No deposit account was found for the provided `destinationAccountId`, or the account does not belong to the calling organization."}},"security":[{"bearer":[]}],"summary":"Simulate a payin","tags":["Sandbox"]}},"/api/transactions/search/account/{accountId}":{"post":{"description":"Search for Transactions associated with the provided Account ID","operationId":"searchTransactionsForAccount","parameters":[{"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"in":"query","name":"nextId","required":false,"schema":{"type":"string"}},{"in":"path","name":"accountId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuralTransactionPaginatedResponse"}}},"description":"Paginated list of Transactions associated with an Account"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Search Transactions","tags":["Transactions"]}},"/api/transactions/{id}":{"get":{"description":"Gets the Transaction identified by the provided ID.","operationId":"getTransaction","parameters":[{"description":"Transaction ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Organization ID to act on behalf of","in":"header","name":"on-behalf-of","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"The Transaction identified by the provided ID"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get a Transaction","tags":["Transactions"]}},"/api/utilities/countries/{fiatRailCode}":{"get":{"description":"Returns valid country and subdivision codes for a specific fiat rail code.","operationId":"getCountriesSupportedForFiatRail","parameters":[{"description":"Fiat rail code that identifies the currency and rail combination","in":"path","name":"fiatRailCode","required":true,"schema":{"enum":["usd","cop","cop-bre-b","cop-cobre-balance","ars","eur","mxn","brl","clp","pen","bob","crc","zar","usd-peru","usd-china","usd-panama","usd-hong-kong"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"countries":[{"alpha2Code":"CO","name":"Colombia","subdivisions":[{"code":"ANT","name":"Antioquia"},{"code":"CUN","name":"Cundinamarca"},{"code":"VAC","name":"Valle del Cauca"}]}]},"schema":{"$ref":"#/components/schemas/CountriesResponse"}}},"description":"List of countries and subdivisions allowed for the specified fiat rail code"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get supported countries and subdivisions for a fiat rail code","tags":["Utilities"]}},"/api/utilities/validations/bre-b":{"get":{"description":"Validate a Bre-B key and return linked holder information if found.","operationId":"validateBreBKey","parameters":[{"description":"The Bre-B key value to validate","in":"query","name":"keyValue","required":true,"schema":{"example":"@CB123456789","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"found":{"summary":"Key found","value":{"holderIdNumber":"123456789","holderName":"Juan Pérez","type":"success"}},"notFound":{"summary":"Key not found","value":{"type":"failure"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/BreBValidationSuccess","title":"Key found"},{"$ref":"#/components/schemas/BreBValidationFailure","title":"Key not found"}]}}},"description":"Validation result: success with holder details when key is found, or failure when not found"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"},"503":{"description":"Key validation is temporarily unavailable. Please try again later."}},"security":[{"bearer":[]}],"summary":"Validate a Bre-B key","tags":["Utilities"]}},"/api/webhooks":{"get":{"description":"Lists all webhooks for the authenticated organization","operationId":"listWebhooks","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MuralWebhook"},"type":"array"}}},"description":"List of webhooks retrieved successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"List webhooks","tags":["Webhooks"]},"post":{"description":"Creates a new webhook endpoint in DISABLED state. Limited to 5 webhooks per organization.","operationId":"createWebhook","parameters":[],"requestBody":{"content":{"application/json":{"examples":{"Create Webhook":{"description":"Example payload for creating a webhook to receive account balance activity events","summary":"Create webhook for account balance events","value":{"categories":["MURAL_ACCOUNT_BALANCE_ACTIVITY"],"url":"https://api.example.com/webhooks/mural"}}},"schema":{"$ref":"#/components/schemas/CreateMuralWebhookInput"}}},"description":"Webhook configuration details","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuralWebhook"}}},"description":"Webhook created successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Create webhook","tags":["Webhooks"]}},"/api/webhooks/{webhookId}":{"delete":{"description":"Deletes a webhook. Webhook will stop receiving events but delivery history is preserved.","operationId":"deleteWebhook","parameters":[{"description":"Webhook ID","in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Delete webhook","tags":["Webhooks"]},"get":{"description":"Retrieves a specific webhook by ID","operationId":"getWebhook","parameters":[{"description":"Webhook ID","in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuralWebhook"}}},"description":"Webhook retrieved successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Get webhook","tags":["Webhooks"]},"patch":{"description":"Partially updates webhook configuration. Only provided fields will be updated. Use the separate status endpoint to activate/deactivate webhooks.","operationId":"updateWebhook","parameters":[{"description":"Webhook ID","in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Update Categories":{"description":"Example payload for updating webhook categories","summary":"Update webhook categories","value":{"categories":["MURAL_ACCOUNT_BALANCE_ACTIVITY"]}},"Update URL":{"description":"Example payload for updating a webhook URL","summary":"Update webhook URL","value":{"url":"https://api.example.com/webhooks/new-endpoint"}}},"schema":{"$ref":"#/components/schemas/UpdateMuralWebhookInput"}}},"description":"Partial webhook update data. Only provided fields will be updated.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuralWebhook"}}},"description":"Webhook updated successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Update webhook","tags":["Webhooks"]}},"/api/webhooks/{webhookId}/ping":{"post":{"description":"Synchronously sends a signed test request to the registered webhook URL and returns the delivery outcome (status code and round-trip time). Works on disabled webhooks so connectivity can be verified before activation.","operationId":"pingWebhook","parameters":[{"description":"Webhook ID","in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"discriminator":{"mapping":{"httpError":"#/components/schemas/WebhookPingHttpError","success":"#/components/schemas/WebhookPingSuccess","unreachable":"#/components/schemas/WebhookPingUnreachable"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/WebhookPingSuccess","title":"Success"},{"$ref":"#/components/schemas/WebhookPingHttpError","title":"HTTP error"},{"$ref":"#/components/schemas/WebhookPingUnreachable","title":"Unreachable"}]}}},"description":"The ping was attempted; the result describes the outcome."},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Ping webhook","tags":["Webhooks"]}},"/api/webhooks/{webhookId}/send":{"post":{"description":"Triggers a test webhook event for the specified webhook and category","operationId":"sendWebhookEvent","parameters":[{"description":"Webhook ID","in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Test by Category":{"summary":"Generate test event by category","value":{"event":{"category":"MURAL_ACCOUNT_BALANCE_ACTIVITY","type":"categoryTest"}}}},"schema":{"$ref":"#/components/schemas/SendWebhookEventRequest"}}},"description":"Test event request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"eventId":{"format":"uuid","type":"string"}},"type":"object"}}},"description":"Test event queued successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Send webhook event","tags":["Webhooks"]}},"/api/webhooks/{webhookId}/status":{"patch":{"description":"Updates the status of a webhook (ACTIVE/DISABLED). This operation is idempotent - if the status is already the requested value, no changes are made.","operationId":"updateWebhookStatus","parameters":[{"description":"Webhook ID","in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"Activate Webhook":{"description":"Example payload for activating a webhook","summary":"Activate webhook","value":{"status":"ACTIVE"}},"Disable Webhook":{"description":"Example payload for disabling a webhook","summary":"Disable webhook","value":{"status":"DISABLED"}}},"schema":{"$ref":"#/components/schemas/UpdateWebhookStatusInput"}}},"description":"Webhook status update data","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuralWebhook"}}},"description":"Webhook status updated successfully"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedAgreementRequiredExceptionBody"}}},"description":"SignedAgreementRequiredException"}},"security":[{"bearer":[]}],"summary":"Update webhook status","tags":["Webhooks"]}}},"servers":[{"description":"Production","url":"https://api.muralpay.com"},{"description":"Sandbox","url":"https://api-staging.muralpay.com"}],"tags":[]}